@goauthentik/api 2026.2.0-rc1-1766103708 → 2026.2.0-rc1-1766493698

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.
Files changed (900) hide show
  1. package/.openapi-generator/FILES +854 -1
  2. package/.openapi-generator/VERSION +1 -1
  3. package/dist/esm/models/CapabilitiesEnum.d.ts +1 -0
  4. package/dist/esm/models/CapabilitiesEnum.d.ts.map +1 -1
  5. package/dist/esm/models/CapabilitiesEnum.js +1 -0
  6. package/dist/esm/models/CapabilitiesEnum.js.map +1 -1
  7. package/dist/esm/models/ContentType.d.ts +7 -1
  8. package/dist/esm/models/ContentType.d.ts.map +1 -1
  9. package/dist/esm/models/ContentType.js +3 -0
  10. package/dist/esm/models/ContentType.js.map +1 -1
  11. package/dist/esm/models/DataExport.d.ts +3 -3
  12. package/dist/esm/models/DataExport.js +2 -2
  13. package/dist/esm/models/index.d.ts +0 -1
  14. package/dist/esm/models/index.d.ts.map +1 -1
  15. package/dist/esm/models/index.js +0 -1
  16. package/dist/esm/models/index.js.map +1 -1
  17. package/dist/models/CapabilitiesEnum.d.ts +1 -0
  18. package/dist/models/CapabilitiesEnum.d.ts.map +1 -1
  19. package/dist/models/CapabilitiesEnum.js +1 -0
  20. package/dist/models/CapabilitiesEnum.js.map +1 -1
  21. package/dist/models/ContentType.d.ts +7 -1
  22. package/dist/models/ContentType.d.ts.map +1 -1
  23. package/dist/models/ContentType.js +3 -0
  24. package/dist/models/ContentType.js.map +1 -1
  25. package/dist/models/DataExport.d.ts +3 -3
  26. package/dist/models/DataExport.js +2 -2
  27. package/dist/models/index.d.ts +0 -1
  28. package/dist/models/index.d.ts.map +1 -1
  29. package/dist/models/index.js +0 -1
  30. package/dist/models/index.js.map +1 -1
  31. package/dist/tsconfig.esm.tsbuildinfo +1 -1
  32. package/docs/AccessDeniedChallenge.md +45 -0
  33. package/docs/AdminApi.md +1018 -0
  34. package/docs/AgentAuthenticationResponse.md +35 -0
  35. package/docs/AgentConfig.md +51 -0
  36. package/docs/AgentConnector.md +68 -0
  37. package/docs/AgentConnectorRequest.md +60 -0
  38. package/docs/AgentPSSODeviceRegistrationRequest.md +41 -0
  39. package/docs/AgentPSSODeviceRegistrationResponse.md +45 -0
  40. package/docs/AgentPSSOUserRegistrationRequest.md +39 -0
  41. package/docs/AgentTokenResponse.md +37 -0
  42. package/docs/AlgEnum.md +32 -0
  43. package/docs/App.md +37 -0
  44. package/docs/AppEnum.md +32 -0
  45. package/docs/AppleChallengeResponseRequest.md +35 -0
  46. package/docs/AppleLoginChallenge.md +47 -0
  47. package/docs/Application.md +65 -0
  48. package/docs/ApplicationEntitlement.md +41 -0
  49. package/docs/ApplicationEntitlementRequest.md +39 -0
  50. package/docs/ApplicationRequest.md +55 -0
  51. package/docs/AuthTypeEnum.md +32 -0
  52. package/docs/AuthenticatedSession.md +53 -0
  53. package/docs/AuthenticatedSessionAsn.md +39 -0
  54. package/docs/AuthenticatedSessionGeoIp.md +43 -0
  55. package/docs/AuthenticatedSessionUserAgent.md +41 -0
  56. package/docs/AuthenticatedSessionUserAgentDevice.md +39 -0
  57. package/docs/AuthenticatedSessionUserAgentOs.md +43 -0
  58. package/docs/AuthenticatedSessionUserAgentUserAgent.md +41 -0
  59. package/docs/AuthenticationEnum.md +32 -0
  60. package/docs/AuthenticatorAttachmentEnum.md +32 -0
  61. package/docs/AuthenticatorDuoChallenge.md +49 -0
  62. package/docs/AuthenticatorDuoChallengeResponseRequest.md +35 -0
  63. package/docs/AuthenticatorDuoStage.md +57 -0
  64. package/docs/AuthenticatorDuoStageDeviceImportResponse.md +36 -0
  65. package/docs/AuthenticatorDuoStageManualDeviceImportRequest.md +36 -0
  66. package/docs/AuthenticatorDuoStageRequest.md +49 -0
  67. package/docs/AuthenticatorEmailChallenge.md +47 -0
  68. package/docs/AuthenticatorEmailChallengeResponseRequest.md +39 -0
  69. package/docs/AuthenticatorEmailStage.md +75 -0
  70. package/docs/AuthenticatorEmailStageRequest.md +63 -0
  71. package/docs/AuthenticatorEndpointGDTCStage.md +53 -0
  72. package/docs/AuthenticatorEndpointGDTCStageRequest.md +41 -0
  73. package/docs/AuthenticatorSMSChallenge.md +45 -0
  74. package/docs/AuthenticatorSMSChallengeResponseRequest.md +39 -0
  75. package/docs/AuthenticatorSMSStage.md +67 -0
  76. package/docs/AuthenticatorSMSStageRequest.md +55 -0
  77. package/docs/AuthenticatorStaticChallenge.md +45 -0
  78. package/docs/AuthenticatorStaticChallengeResponseRequest.md +35 -0
  79. package/docs/AuthenticatorStaticStage.md +55 -0
  80. package/docs/AuthenticatorStaticStageRequest.md +43 -0
  81. package/docs/AuthenticatorTOTPChallenge.md +45 -0
  82. package/docs/AuthenticatorTOTPChallengeResponseRequest.md +37 -0
  83. package/docs/AuthenticatorTOTPStage.md +53 -0
  84. package/docs/AuthenticatorTOTPStageRequest.md +41 -0
  85. package/docs/AuthenticatorValidateStage.md +61 -0
  86. package/docs/AuthenticatorValidateStageRequest.md +47 -0
  87. package/docs/AuthenticatorValidationChallenge.md +47 -0
  88. package/docs/AuthenticatorValidationChallengeResponseRequest.md +45 -0
  89. package/docs/AuthenticatorWebAuthnChallenge.md +45 -0
  90. package/docs/AuthenticatorWebAuthnChallengeResponseRequest.md +37 -0
  91. package/docs/AuthenticatorWebAuthnStage.md +63 -0
  92. package/docs/AuthenticatorWebAuthnStageRequest.md +49 -0
  93. package/docs/AuthenticatorsApi.md +6388 -0
  94. package/docs/AuthorizationCodeAuthMethodEnum.md +32 -0
  95. package/docs/AutoSubmitChallengeResponseRequest.md +35 -0
  96. package/docs/AutosubmitChallenge.md +45 -0
  97. package/docs/BackendsEnum.md +32 -0
  98. package/docs/BindingTypeEnum.md +32 -0
  99. package/docs/BlueprintFile.md +40 -0
  100. package/docs/BlueprintInstance.md +55 -0
  101. package/docs/BlueprintInstanceRequest.md +43 -0
  102. package/docs/BlueprintInstanceStatusEnum.md +32 -0
  103. package/docs/Brand.md +69 -0
  104. package/docs/BrandRequest.md +67 -0
  105. package/docs/Cache.md +35 -0
  106. package/docs/CapabilitiesEnum.md +32 -0
  107. package/docs/CaptchaChallenge.md +49 -0
  108. package/docs/CaptchaChallengeResponseRequest.md +37 -0
  109. package/docs/CaptchaStage.md +61 -0
  110. package/docs/CaptchaStageRequest.md +51 -0
  111. package/docs/CertAttributeEnum.md +32 -0
  112. package/docs/CertificateData.md +35 -0
  113. package/docs/CertificateGenerationRequest.md +41 -0
  114. package/docs/CertificateKeyPair.md +55 -0
  115. package/docs/CertificateKeyPairRequest.md +39 -0
  116. package/docs/ChallengeTypes.md +174 -0
  117. package/docs/ClientTypeEnum.md +32 -0
  118. package/docs/CompatibilityModeEnum.md +32 -0
  119. package/docs/Config.md +43 -0
  120. package/docs/ConnectionToken.md +45 -0
  121. package/docs/ConnectionTokenRequest.md +39 -0
  122. package/docs/Connector.md +46 -0
  123. package/docs/ConsentChallenge.md +51 -0
  124. package/docs/ConsentChallengeResponseRequest.md +37 -0
  125. package/docs/ConsentPermission.md +37 -0
  126. package/docs/ConsentStage.md +51 -0
  127. package/docs/ConsentStageModeEnum.md +32 -0
  128. package/docs/ConsentStageRequest.md +39 -0
  129. package/docs/ContentType.md +40 -0
  130. package/docs/ContextualFlowInfo.md +41 -0
  131. package/docs/ContextualFlowInfoLayoutEnum.md +32 -0
  132. package/docs/CoreApi.md +5280 -0
  133. package/docs/CountryCodeEnum.md +32 -0
  134. package/docs/CryptoApi.md +781 -0
  135. package/docs/CurrentBrand.md +63 -0
  136. package/docs/CurrentBrandFlags.md +36 -0
  137. package/docs/DataExport.md +47 -0
  138. package/docs/DeliveryMethodEnum.md +32 -0
  139. package/docs/DeniedActionEnum.md +32 -0
  140. package/docs/DenyStage.md +49 -0
  141. package/docs/DenyStageRequest.md +37 -0
  142. package/docs/DetailedCountry.md +36 -0
  143. package/docs/DetailedCountryField.md +36 -0
  144. package/docs/Device.md +57 -0
  145. package/docs/DeviceAccessGroup.md +36 -0
  146. package/docs/DeviceAccessGroupRequest.md +34 -0
  147. package/docs/DeviceChallenge.md +41 -0
  148. package/docs/DeviceChallengeRequest.md +41 -0
  149. package/docs/DeviceClassesEnum.md +32 -0
  150. package/docs/DeviceConnection.md +40 -0
  151. package/docs/DeviceFactSnapshot.md +40 -0
  152. package/docs/DeviceFacts.md +50 -0
  153. package/docs/DeviceFactsOSFamily.md +32 -0
  154. package/docs/DeviceFactsRequest.md +50 -0
  155. package/docs/DeviceGroup.md +36 -0
  156. package/docs/DeviceGroupRequest.md +36 -0
  157. package/docs/DeviceSummary.md +39 -0
  158. package/docs/DeviceUser.md +40 -0
  159. package/docs/DeviceUserBinding.md +65 -0
  160. package/docs/DeviceUserBindingRequest.md +53 -0
  161. package/docs/DeviceUserRequest.md +40 -0
  162. package/docs/DigestAlgorithmEnum.md +32 -0
  163. package/docs/DigitsEnum.md +32 -0
  164. package/docs/Disk.md +44 -0
  165. package/docs/DiskRequest.md +44 -0
  166. package/docs/DockerServiceConnection.md +53 -0
  167. package/docs/DockerServiceConnectionRequest.md +43 -0
  168. package/docs/Domain.md +41 -0
  169. package/docs/DomainRequest.md +39 -0
  170. package/docs/DummyChallenge.md +41 -0
  171. package/docs/DummyChallengeResponseRequest.md +35 -0
  172. package/docs/DummyPolicy.md +55 -0
  173. package/docs/DummyPolicyRequest.md +43 -0
  174. package/docs/DummyStage.md +49 -0
  175. package/docs/DummyStageRequest.md +37 -0
  176. package/docs/DuoDevice.md +39 -0
  177. package/docs/DuoDeviceEnrollmentStatus.md +34 -0
  178. package/docs/DuoDeviceRequest.md +35 -0
  179. package/docs/DuoResponseEnum.md +32 -0
  180. package/docs/EmailChallenge.md +39 -0
  181. package/docs/EmailChallengeResponseRequest.md +35 -0
  182. package/docs/EmailDevice.md +41 -0
  183. package/docs/EmailDeviceRequest.md +35 -0
  184. package/docs/EmailStage.md +75 -0
  185. package/docs/EmailStageRequest.md +65 -0
  186. package/docs/Endpoint.md +55 -0
  187. package/docs/EndpointAgentChallenge.md +43 -0
  188. package/docs/EndpointAgentChallengeResponseRequest.md +37 -0
  189. package/docs/EndpointAuthModeEnum.md +32 -0
  190. package/docs/EndpointDevice.md +50 -0
  191. package/docs/EndpointDeviceDetails.md +56 -0
  192. package/docs/EndpointDeviceRequest.md +46 -0
  193. package/docs/EndpointRequest.md +49 -0
  194. package/docs/EndpointStage.md +53 -0
  195. package/docs/EndpointStageRequest.md +39 -0
  196. package/docs/EndpointsApi.md +3704 -0
  197. package/docs/EnrollRequest.md +37 -0
  198. package/docs/EnrollmentToken.md +46 -0
  199. package/docs/EnrollmentTokenRequest.md +42 -0
  200. package/docs/EnterpriseApi.md +750 -0
  201. package/docs/ErrorDetail.md +37 -0
  202. package/docs/ErrorReportingConfig.md +43 -0
  203. package/docs/Event.md +51 -0
  204. package/docs/EventActions.md +32 -0
  205. package/docs/EventMatcherPolicy.md +57 -0
  206. package/docs/EventMatcherPolicyRequest.md +45 -0
  207. package/docs/EventRequest.md +47 -0
  208. package/docs/EventTopPerUser.md +39 -0
  209. package/docs/EventVolume.md +39 -0
  210. package/docs/EventsApi.md +2553 -0
  211. package/docs/EventsRequestedEnum.md +32 -0
  212. package/docs/ExpiringBaseGrantModel.md +45 -0
  213. package/docs/ExpressionPolicy.md +51 -0
  214. package/docs/ExpressionPolicyRequest.md +39 -0
  215. package/docs/ExtraRoleObjectPermission.md +51 -0
  216. package/docs/FileList.md +39 -0
  217. package/docs/Flow.md +67 -0
  218. package/docs/FlowChallengeResponseRequest.md +78 -0
  219. package/docs/FlowDesignationEnum.md +32 -0
  220. package/docs/FlowDiagram.md +35 -0
  221. package/docs/FlowErrorChallenge.md +45 -0
  222. package/docs/FlowImportResult.md +37 -0
  223. package/docs/FlowInspection.md +39 -0
  224. package/docs/FlowInspectorPlan.md +41 -0
  225. package/docs/FlowLayoutEnum.md +32 -0
  226. package/docs/FlowRequest.md +53 -0
  227. package/docs/FlowSet.md +57 -0
  228. package/docs/FlowStageBinding.md +53 -0
  229. package/docs/FlowStageBindingRequest.md +47 -0
  230. package/docs/FlowsApi.md +1781 -0
  231. package/docs/FooterLink.md +37 -0
  232. package/docs/FrameChallenge.md +45 -0
  233. package/docs/FrameChallengeResponseRequest.md +35 -0
  234. package/docs/GenericError.md +37 -0
  235. package/docs/GeoIPPolicy.md +67 -0
  236. package/docs/GeoIPPolicyRequest.md +53 -0
  237. package/docs/GeoipBindingEnum.md +32 -0
  238. package/docs/GlobalTaskStatus.md +52 -0
  239. package/docs/GoogleEndpointDevice.md +37 -0
  240. package/docs/GoogleEndpointDeviceRequest.md +37 -0
  241. package/docs/GoogleWorkspaceProvider.md +75 -0
  242. package/docs/GoogleWorkspaceProviderGroup.md +45 -0
  243. package/docs/GoogleWorkspaceProviderGroupRequest.md +39 -0
  244. package/docs/GoogleWorkspaceProviderMapping.md +49 -0
  245. package/docs/GoogleWorkspaceProviderMappingRequest.md +39 -0
  246. package/docs/GoogleWorkspaceProviderRequest.md +61 -0
  247. package/docs/GoogleWorkspaceProviderUser.md +45 -0
  248. package/docs/GoogleWorkspaceProviderUserRequest.md +39 -0
  249. package/docs/Group.md +59 -0
  250. package/docs/GroupKerberosSourceConnection.md +47 -0
  251. package/docs/GroupKerberosSourceConnectionRequest.md +39 -0
  252. package/docs/GroupLDAPSourceConnection.md +47 -0
  253. package/docs/GroupLDAPSourceConnectionRequest.md +39 -0
  254. package/docs/GroupMatchingModeEnum.md +32 -0
  255. package/docs/GroupOAuthSourceConnection.md +47 -0
  256. package/docs/GroupOAuthSourceConnectionRequest.md +39 -0
  257. package/docs/GroupPlexSourceConnection.md +47 -0
  258. package/docs/GroupPlexSourceConnectionRequest.md +39 -0
  259. package/docs/GroupRequest.md +45 -0
  260. package/docs/GroupSAMLSourceConnection.md +47 -0
  261. package/docs/GroupSAMLSourceConnectionRequest.md +39 -0
  262. package/docs/GroupSourceConnection.md +47 -0
  263. package/docs/GroupSourceConnectionRequest.md +39 -0
  264. package/docs/GroupTelegramSourceConnection.md +47 -0
  265. package/docs/GroupTelegramSourceConnectionRequest.md +39 -0
  266. package/docs/Hardware.md +44 -0
  267. package/docs/HardwareRequest.md +44 -0
  268. package/docs/IdentificationChallenge.md +67 -0
  269. package/docs/IdentificationChallengeResponseRequest.md +43 -0
  270. package/docs/IdentificationStage.md +73 -0
  271. package/docs/IdentificationStageRequest.md +61 -0
  272. package/docs/IframeLogoutChallenge.md +41 -0
  273. package/docs/IframeLogoutChallengeResponseRequest.md +35 -0
  274. package/docs/ImpersonationRequest.md +34 -0
  275. package/docs/InitialPermissions.md +43 -0
  276. package/docs/InitialPermissionsRequest.md +39 -0
  277. package/docs/InstallID.md +34 -0
  278. package/docs/IntentEnum.md +32 -0
  279. package/docs/InvalidResponseActionEnum.md +32 -0
  280. package/docs/Invitation.md +49 -0
  281. package/docs/InvitationRequest.md +43 -0
  282. package/docs/InvitationStage.md +49 -0
  283. package/docs/InvitationStageRequest.md +37 -0
  284. package/docs/IssuerModeEnum.md +32 -0
  285. package/docs/KadminTypeEnum.md +32 -0
  286. package/docs/KerberosSource.md +97 -0
  287. package/docs/KerberosSourcePropertyMapping.md +49 -0
  288. package/docs/KerberosSourcePropertyMappingRequest.md +39 -0
  289. package/docs/KerberosSourceRequest.md +87 -0
  290. package/docs/KeyTypeEnum.md +32 -0
  291. package/docs/KubernetesServiceConnection.md +51 -0
  292. package/docs/KubernetesServiceConnectionRequest.md +41 -0
  293. package/docs/LDAPAPIAccessMode.md +32 -0
  294. package/docs/LDAPCheckAccess.md +37 -0
  295. package/docs/LDAPDebug.md +38 -0
  296. package/docs/LDAPOutpostConfig.md +59 -0
  297. package/docs/LDAPProvider.md +79 -0
  298. package/docs/LDAPProviderRequest.md +59 -0
  299. package/docs/LDAPSource.md +117 -0
  300. package/docs/LDAPSourcePropertyMapping.md +49 -0
  301. package/docs/LDAPSourcePropertyMappingRequest.md +39 -0
  302. package/docs/LDAPSourceRequest.md +103 -0
  303. package/docs/LastTaskStatusEnum.md +32 -0
  304. package/docs/License.md +45 -0
  305. package/docs/LicenseFlagsEnum.md +32 -0
  306. package/docs/LicenseForecast.md +41 -0
  307. package/docs/LicenseRequest.md +35 -0
  308. package/docs/LicenseSummary.md +43 -0
  309. package/docs/LicenseSummaryStatusEnum.md +32 -0
  310. package/docs/Link.md +35 -0
  311. package/docs/LogEvent.md +43 -0
  312. package/docs/LogLevelEnum.md +32 -0
  313. package/docs/LoginChallengeTypes.md +54 -0
  314. package/docs/LoginSource.md +41 -0
  315. package/docs/MDMConfigRequest.md +37 -0
  316. package/docs/MDMConfigResponse.md +39 -0
  317. package/docs/ManagedApi.md +687 -0
  318. package/docs/MatchingModeEnum.md +32 -0
  319. package/docs/Metadata.md +37 -0
  320. package/docs/MicrosoftEntraProvider.md +73 -0
  321. package/docs/MicrosoftEntraProviderGroup.md +45 -0
  322. package/docs/MicrosoftEntraProviderGroupRequest.md +39 -0
  323. package/docs/MicrosoftEntraProviderMapping.md +49 -0
  324. package/docs/MicrosoftEntraProviderMappingRequest.md +39 -0
  325. package/docs/MicrosoftEntraProviderRequest.md +59 -0
  326. package/docs/MicrosoftEntraProviderUser.md +45 -0
  327. package/docs/MicrosoftEntraProviderUserRequest.md +39 -0
  328. package/docs/ModelEnum.md +32 -0
  329. package/docs/ModelRequest.md +210 -0
  330. package/docs/MutualTLSStage.md +55 -0
  331. package/docs/MutualTLSStageRequest.md +43 -0
  332. package/docs/NativeLogoutChallenge.md +53 -0
  333. package/docs/NativeLogoutChallengeResponseRequest.md +35 -0
  334. package/docs/Network.md +40 -0
  335. package/docs/NetworkBindingEnum.md +32 -0
  336. package/docs/NetworkInterface.md +40 -0
  337. package/docs/NetworkInterfaceRequest.md +40 -0
  338. package/docs/NetworkRequest.md +40 -0
  339. package/docs/NotConfiguredActionEnum.md +32 -0
  340. package/docs/Notification.md +49 -0
  341. package/docs/NotificationRequest.md +41 -0
  342. package/docs/NotificationRule.md +47 -0
  343. package/docs/NotificationRuleRequest.md +43 -0
  344. package/docs/NotificationTransport.md +53 -0
  345. package/docs/NotificationTransportModeEnum.md +32 -0
  346. package/docs/NotificationTransportRequest.md +49 -0
  347. package/docs/NotificationTransportTest.md +35 -0
  348. package/docs/NotificationWebhookMapping.md +39 -0
  349. package/docs/NotificationWebhookMappingRequest.md +37 -0
  350. package/docs/OAuth2Provider.md +95 -0
  351. package/docs/OAuth2ProviderLogoutMethodEnum.md +32 -0
  352. package/docs/OAuth2ProviderRequest.md +77 -0
  353. package/docs/OAuth2ProviderSetupURLs.md +47 -0
  354. package/docs/OAuthDeviceCodeChallenge.md +39 -0
  355. package/docs/OAuthDeviceCodeChallengeResponseRequest.md +37 -0
  356. package/docs/OAuthDeviceCodeFinishChallenge.md +39 -0
  357. package/docs/OAuthDeviceCodeFinishChallengeResponseRequest.md +35 -0
  358. package/docs/OAuthSource.md +101 -0
  359. package/docs/OAuthSourcePropertyMapping.md +49 -0
  360. package/docs/OAuthSourcePropertyMappingRequest.md +39 -0
  361. package/docs/OAuthSourceRequest.md +85 -0
  362. package/docs/Oauth2Api.md +941 -0
  363. package/docs/OpenIDConnectConfiguration.md +55 -0
  364. package/docs/OperatingSystem.md +40 -0
  365. package/docs/OperatingSystemRequest.md +40 -0
  366. package/docs/OutgoingSyncDeleteAction.md +32 -0
  367. package/docs/Outpost.md +55 -0
  368. package/docs/OutpostDefaultConfig.md +35 -0
  369. package/docs/OutpostHealth.md +57 -0
  370. package/docs/OutpostRequest.md +45 -0
  371. package/docs/OutpostTypeEnum.md +32 -0
  372. package/docs/OutpostsApi.md +2682 -0
  373. package/docs/PKCEMethodEnum.md +32 -0
  374. package/docs/PaginatedAgentConnectorList.md +38 -0
  375. package/docs/PaginatedApplicationEntitlementList.md +38 -0
  376. package/docs/PaginatedApplicationList.md +38 -0
  377. package/docs/PaginatedAuthenticatedSessionList.md +38 -0
  378. package/docs/PaginatedAuthenticatorDuoStageList.md +38 -0
  379. package/docs/PaginatedAuthenticatorEmailStageList.md +38 -0
  380. package/docs/PaginatedAuthenticatorEndpointGDTCStageList.md +38 -0
  381. package/docs/PaginatedAuthenticatorSMSStageList.md +38 -0
  382. package/docs/PaginatedAuthenticatorStaticStageList.md +38 -0
  383. package/docs/PaginatedAuthenticatorTOTPStageList.md +38 -0
  384. package/docs/PaginatedAuthenticatorValidateStageList.md +38 -0
  385. package/docs/PaginatedAuthenticatorWebAuthnStageList.md +38 -0
  386. package/docs/PaginatedBlueprintInstanceList.md +38 -0
  387. package/docs/PaginatedBrandList.md +38 -0
  388. package/docs/PaginatedCaptchaStageList.md +38 -0
  389. package/docs/PaginatedCertificateKeyPairList.md +38 -0
  390. package/docs/PaginatedConnectionTokenList.md +38 -0
  391. package/docs/PaginatedConnectorList.md +38 -0
  392. package/docs/PaginatedConsentStageList.md +38 -0
  393. package/docs/PaginatedDataExportList.md +38 -0
  394. package/docs/PaginatedDenyStageList.md +38 -0
  395. package/docs/PaginatedDeviceAccessGroupList.md +38 -0
  396. package/docs/PaginatedDeviceUserBindingList.md +38 -0
  397. package/docs/PaginatedDockerServiceConnectionList.md +38 -0
  398. package/docs/PaginatedDomainList.md +38 -0
  399. package/docs/PaginatedDummyPolicyList.md +38 -0
  400. package/docs/PaginatedDummyStageList.md +38 -0
  401. package/docs/PaginatedDuoDeviceList.md +38 -0
  402. package/docs/PaginatedEmailDeviceList.md +38 -0
  403. package/docs/PaginatedEmailStageList.md +38 -0
  404. package/docs/PaginatedEndpointDeviceList.md +38 -0
  405. package/docs/PaginatedEndpointList.md +38 -0
  406. package/docs/PaginatedEndpointStageList.md +38 -0
  407. package/docs/PaginatedEnrollmentTokenList.md +38 -0
  408. package/docs/PaginatedEventList.md +38 -0
  409. package/docs/PaginatedEventMatcherPolicyList.md +38 -0
  410. package/docs/PaginatedExpiringBaseGrantModelList.md +38 -0
  411. package/docs/PaginatedExpressionPolicyList.md +38 -0
  412. package/docs/PaginatedExtraRoleObjectPermissionList.md +36 -0
  413. package/docs/PaginatedFlowList.md +38 -0
  414. package/docs/PaginatedFlowStageBindingList.md +38 -0
  415. package/docs/PaginatedGeoIPPolicyList.md +38 -0
  416. package/docs/PaginatedGoogleEndpointDeviceList.md +38 -0
  417. package/docs/PaginatedGoogleWorkspaceProviderGroupList.md +38 -0
  418. package/docs/PaginatedGoogleWorkspaceProviderList.md +38 -0
  419. package/docs/PaginatedGoogleWorkspaceProviderMappingList.md +38 -0
  420. package/docs/PaginatedGoogleWorkspaceProviderUserList.md +38 -0
  421. package/docs/PaginatedGroupKerberosSourceConnectionList.md +38 -0
  422. package/docs/PaginatedGroupLDAPSourceConnectionList.md +38 -0
  423. package/docs/PaginatedGroupList.md +38 -0
  424. package/docs/PaginatedGroupOAuthSourceConnectionList.md +38 -0
  425. package/docs/PaginatedGroupPlexSourceConnectionList.md +38 -0
  426. package/docs/PaginatedGroupSAMLSourceConnectionList.md +38 -0
  427. package/docs/PaginatedGroupSourceConnectionList.md +38 -0
  428. package/docs/PaginatedGroupTelegramSourceConnectionList.md +38 -0
  429. package/docs/PaginatedIdentificationStageList.md +38 -0
  430. package/docs/PaginatedInitialPermissionsList.md +38 -0
  431. package/docs/PaginatedInvitationList.md +38 -0
  432. package/docs/PaginatedInvitationStageList.md +38 -0
  433. package/docs/PaginatedKerberosSourceList.md +38 -0
  434. package/docs/PaginatedKerberosSourcePropertyMappingList.md +38 -0
  435. package/docs/PaginatedKubernetesServiceConnectionList.md +38 -0
  436. package/docs/PaginatedLDAPOutpostConfigList.md +38 -0
  437. package/docs/PaginatedLDAPProviderList.md +38 -0
  438. package/docs/PaginatedLDAPSourceList.md +38 -0
  439. package/docs/PaginatedLDAPSourcePropertyMappingList.md +38 -0
  440. package/docs/PaginatedLicenseList.md +38 -0
  441. package/docs/PaginatedMicrosoftEntraProviderGroupList.md +38 -0
  442. package/docs/PaginatedMicrosoftEntraProviderList.md +38 -0
  443. package/docs/PaginatedMicrosoftEntraProviderMappingList.md +38 -0
  444. package/docs/PaginatedMicrosoftEntraProviderUserList.md +38 -0
  445. package/docs/PaginatedMutualTLSStageList.md +38 -0
  446. package/docs/PaginatedNotificationList.md +38 -0
  447. package/docs/PaginatedNotificationRuleList.md +38 -0
  448. package/docs/PaginatedNotificationTransportList.md +38 -0
  449. package/docs/PaginatedNotificationWebhookMappingList.md +38 -0
  450. package/docs/PaginatedOAuth2ProviderList.md +38 -0
  451. package/docs/PaginatedOAuthSourceList.md +38 -0
  452. package/docs/PaginatedOAuthSourcePropertyMappingList.md +38 -0
  453. package/docs/PaginatedOutpostList.md +38 -0
  454. package/docs/PaginatedPasswordExpiryPolicyList.md +38 -0
  455. package/docs/PaginatedPasswordPolicyList.md +38 -0
  456. package/docs/PaginatedPasswordStageList.md +38 -0
  457. package/docs/PaginatedPermissionList.md +38 -0
  458. package/docs/PaginatedPlexSourceList.md +38 -0
  459. package/docs/PaginatedPlexSourcePropertyMappingList.md +38 -0
  460. package/docs/PaginatedPolicyBindingList.md +38 -0
  461. package/docs/PaginatedPolicyList.md +38 -0
  462. package/docs/PaginatedPromptList.md +38 -0
  463. package/docs/PaginatedPromptStageList.md +38 -0
  464. package/docs/PaginatedPropertyMappingList.md +38 -0
  465. package/docs/PaginatedProviderList.md +38 -0
  466. package/docs/PaginatedProxyOutpostConfigList.md +38 -0
  467. package/docs/PaginatedProxyProviderList.md +38 -0
  468. package/docs/PaginatedRACPropertyMappingList.md +38 -0
  469. package/docs/PaginatedRACProviderList.md +38 -0
  470. package/docs/PaginatedRadiusOutpostConfigList.md +38 -0
  471. package/docs/PaginatedRadiusProviderList.md +38 -0
  472. package/docs/PaginatedRadiusProviderPropertyMappingList.md +38 -0
  473. package/docs/PaginatedRedirectStageList.md +38 -0
  474. package/docs/PaginatedReputationList.md +38 -0
  475. package/docs/PaginatedReputationPolicyList.md +38 -0
  476. package/docs/PaginatedRoleAssignedObjectPermissionList.md +38 -0
  477. package/docs/PaginatedRoleList.md +38 -0
  478. package/docs/PaginatedSAMLPropertyMappingList.md +38 -0
  479. package/docs/PaginatedSAMLProviderList.md +38 -0
  480. package/docs/PaginatedSAMLSourceList.md +38 -0
  481. package/docs/PaginatedSAMLSourcePropertyMappingList.md +38 -0
  482. package/docs/PaginatedSCIMMappingList.md +38 -0
  483. package/docs/PaginatedSCIMProviderGroupList.md +38 -0
  484. package/docs/PaginatedSCIMProviderList.md +38 -0
  485. package/docs/PaginatedSCIMProviderUserList.md +38 -0
  486. package/docs/PaginatedSCIMSourceGroupList.md +38 -0
  487. package/docs/PaginatedSCIMSourceList.md +38 -0
  488. package/docs/PaginatedSCIMSourcePropertyMappingList.md +38 -0
  489. package/docs/PaginatedSCIMSourceUserList.md +38 -0
  490. package/docs/PaginatedSMSDeviceList.md +38 -0
  491. package/docs/PaginatedSSFProviderList.md +38 -0
  492. package/docs/PaginatedSSFStreamList.md +38 -0
  493. package/docs/PaginatedScheduleList.md +38 -0
  494. package/docs/PaginatedScopeMappingList.md +38 -0
  495. package/docs/PaginatedServiceConnectionList.md +38 -0
  496. package/docs/PaginatedSourceList.md +38 -0
  497. package/docs/PaginatedSourceStageList.md +38 -0
  498. package/docs/PaginatedStageList.md +38 -0
  499. package/docs/PaginatedStaticDeviceList.md +38 -0
  500. package/docs/PaginatedTOTPDeviceList.md +38 -0
  501. package/docs/PaginatedTaskList.md +38 -0
  502. package/docs/PaginatedTelegramSourceList.md +38 -0
  503. package/docs/PaginatedTelegramSourcePropertyMappingList.md +38 -0
  504. package/docs/PaginatedTenantList.md +38 -0
  505. package/docs/PaginatedTokenList.md +38 -0
  506. package/docs/PaginatedTokenModelList.md +38 -0
  507. package/docs/PaginatedUniquePasswordPolicyList.md +38 -0
  508. package/docs/PaginatedUserConsentList.md +38 -0
  509. package/docs/PaginatedUserDeleteStageList.md +38 -0
  510. package/docs/PaginatedUserKerberosSourceConnectionList.md +38 -0
  511. package/docs/PaginatedUserLDAPSourceConnectionList.md +38 -0
  512. package/docs/PaginatedUserList.md +38 -0
  513. package/docs/PaginatedUserLoginStageList.md +38 -0
  514. package/docs/PaginatedUserLogoutStageList.md +38 -0
  515. package/docs/PaginatedUserOAuthSourceConnectionList.md +38 -0
  516. package/docs/PaginatedUserPlexSourceConnectionList.md +38 -0
  517. package/docs/PaginatedUserSAMLSourceConnectionList.md +38 -0
  518. package/docs/PaginatedUserSourceConnectionList.md +38 -0
  519. package/docs/PaginatedUserTelegramSourceConnectionList.md +38 -0
  520. package/docs/PaginatedUserWriteStageList.md +38 -0
  521. package/docs/PaginatedWebAuthnDeviceList.md +38 -0
  522. package/docs/PaginatedWebAuthnDeviceTypeList.md +38 -0
  523. package/docs/Pagination.md +46 -0
  524. package/docs/PartialGroup.md +43 -0
  525. package/docs/PartialUser.md +49 -0
  526. package/docs/PasswordChallenge.md +47 -0
  527. package/docs/PasswordChallengeResponseRequest.md +37 -0
  528. package/docs/PasswordExpiryPolicy.md +53 -0
  529. package/docs/PasswordExpiryPolicyRequest.md +41 -0
  530. package/docs/PasswordPolicy.md +75 -0
  531. package/docs/PasswordPolicyRequest.md +63 -0
  532. package/docs/PasswordStage.md +55 -0
  533. package/docs/PasswordStageRequest.md +43 -0
  534. package/docs/PatchedAgentConnectorRequest.md +60 -0
  535. package/docs/PatchedApplicationEntitlementRequest.md +39 -0
  536. package/docs/PatchedApplicationRequest.md +55 -0
  537. package/docs/PatchedAuthenticatorDuoStageRequest.md +49 -0
  538. package/docs/PatchedAuthenticatorEmailStageRequest.md +63 -0
  539. package/docs/PatchedAuthenticatorEndpointGDTCStageRequest.md +41 -0
  540. package/docs/PatchedAuthenticatorSMSStageRequest.md +55 -0
  541. package/docs/PatchedAuthenticatorStaticStageRequest.md +43 -0
  542. package/docs/PatchedAuthenticatorTOTPStageRequest.md +41 -0
  543. package/docs/PatchedAuthenticatorValidateStageRequest.md +47 -0
  544. package/docs/PatchedAuthenticatorWebAuthnStageRequest.md +49 -0
  545. package/docs/PatchedBlueprintInstanceRequest.md +43 -0
  546. package/docs/PatchedBrandRequest.md +67 -0
  547. package/docs/PatchedCaptchaStageRequest.md +51 -0
  548. package/docs/PatchedCertificateKeyPairRequest.md +39 -0
  549. package/docs/PatchedConnectionTokenRequest.md +39 -0
  550. package/docs/PatchedConsentStageRequest.md +39 -0
  551. package/docs/PatchedDenyStageRequest.md +37 -0
  552. package/docs/PatchedDeviceAccessGroupRequest.md +34 -0
  553. package/docs/PatchedDeviceUserBindingRequest.md +53 -0
  554. package/docs/PatchedDockerServiceConnectionRequest.md +43 -0
  555. package/docs/PatchedDomainRequest.md +39 -0
  556. package/docs/PatchedDummyPolicyRequest.md +43 -0
  557. package/docs/PatchedDummyStageRequest.md +37 -0
  558. package/docs/PatchedDuoDeviceRequest.md +35 -0
  559. package/docs/PatchedEmailDeviceRequest.md +35 -0
  560. package/docs/PatchedEmailStageRequest.md +65 -0
  561. package/docs/PatchedEndpointDeviceRequest.md +46 -0
  562. package/docs/PatchedEndpointRequest.md +49 -0
  563. package/docs/PatchedEndpointStageRequest.md +39 -0
  564. package/docs/PatchedEnrollmentTokenRequest.md +42 -0
  565. package/docs/PatchedEventMatcherPolicyRequest.md +45 -0
  566. package/docs/PatchedEventRequest.md +47 -0
  567. package/docs/PatchedExpressionPolicyRequest.md +39 -0
  568. package/docs/PatchedFlowRequest.md +53 -0
  569. package/docs/PatchedFlowStageBindingRequest.md +47 -0
  570. package/docs/PatchedGeoIPPolicyRequest.md +53 -0
  571. package/docs/PatchedGoogleEndpointDeviceRequest.md +37 -0
  572. package/docs/PatchedGoogleWorkspaceProviderMappingRequest.md +39 -0
  573. package/docs/PatchedGoogleWorkspaceProviderRequest.md +61 -0
  574. package/docs/PatchedGroupKerberosSourceConnectionRequest.md +39 -0
  575. package/docs/PatchedGroupLDAPSourceConnectionRequest.md +39 -0
  576. package/docs/PatchedGroupOAuthSourceConnectionRequest.md +39 -0
  577. package/docs/PatchedGroupPlexSourceConnectionRequest.md +39 -0
  578. package/docs/PatchedGroupRequest.md +45 -0
  579. package/docs/PatchedGroupSAMLSourceConnectionRequest.md +39 -0
  580. package/docs/PatchedGroupSourceConnectionRequest.md +39 -0
  581. package/docs/PatchedGroupTelegramSourceConnectionRequest.md +39 -0
  582. package/docs/PatchedIdentificationStageRequest.md +61 -0
  583. package/docs/PatchedInitialPermissionsRequest.md +39 -0
  584. package/docs/PatchedInvitationRequest.md +43 -0
  585. package/docs/PatchedInvitationStageRequest.md +37 -0
  586. package/docs/PatchedKerberosSourcePropertyMappingRequest.md +39 -0
  587. package/docs/PatchedKerberosSourceRequest.md +87 -0
  588. package/docs/PatchedKubernetesServiceConnectionRequest.md +41 -0
  589. package/docs/PatchedLDAPProviderRequest.md +59 -0
  590. package/docs/PatchedLDAPSourcePropertyMappingRequest.md +39 -0
  591. package/docs/PatchedLDAPSourceRequest.md +103 -0
  592. package/docs/PatchedLicenseRequest.md +35 -0
  593. package/docs/PatchedMicrosoftEntraProviderMappingRequest.md +39 -0
  594. package/docs/PatchedMicrosoftEntraProviderRequest.md +59 -0
  595. package/docs/PatchedMutualTLSStageRequest.md +43 -0
  596. package/docs/PatchedNotificationRequest.md +41 -0
  597. package/docs/PatchedNotificationRuleRequest.md +43 -0
  598. package/docs/PatchedNotificationTransportRequest.md +49 -0
  599. package/docs/PatchedNotificationWebhookMappingRequest.md +37 -0
  600. package/docs/PatchedOAuth2ProviderRequest.md +77 -0
  601. package/docs/PatchedOAuthSourcePropertyMappingRequest.md +39 -0
  602. package/docs/PatchedOAuthSourceRequest.md +85 -0
  603. package/docs/PatchedOutpostRequest.md +45 -0
  604. package/docs/PatchedPasswordExpiryPolicyRequest.md +41 -0
  605. package/docs/PatchedPasswordPolicyRequest.md +63 -0
  606. package/docs/PatchedPasswordStageRequest.md +43 -0
  607. package/docs/PatchedPermissionAssignRequest.md +39 -0
  608. package/docs/PatchedPlexSourcePropertyMappingRequest.md +39 -0
  609. package/docs/PatchedPlexSourceRequest.md +67 -0
  610. package/docs/PatchedPolicyBindingRequest.md +51 -0
  611. package/docs/PatchedPromptRequest.md +55 -0
  612. package/docs/PatchedPromptStageRequest.md +39 -0
  613. package/docs/PatchedProxyProviderRequest.md +73 -0
  614. package/docs/PatchedRACPropertyMappingRequest.md +41 -0
  615. package/docs/PatchedRACProviderRequest.md +47 -0
  616. package/docs/PatchedRadiusProviderPropertyMappingRequest.md +39 -0
  617. package/docs/PatchedRadiusProviderRequest.md +51 -0
  618. package/docs/PatchedRedirectStageRequest.md +43 -0
  619. package/docs/PatchedReputationPolicyRequest.md +43 -0
  620. package/docs/PatchedRoleRequest.md +35 -0
  621. package/docs/PatchedSAMLPropertyMappingRequest.md +43 -0
  622. package/docs/PatchedSAMLProviderRequest.md +87 -0
  623. package/docs/PatchedSAMLSourcePropertyMappingRequest.md +39 -0
  624. package/docs/PatchedSAMLSourceRequest.md +89 -0
  625. package/docs/PatchedSCIMMappingRequest.md +39 -0
  626. package/docs/PatchedSCIMProviderRequest.md +65 -0
  627. package/docs/PatchedSCIMSourceGroupRequest.md +43 -0
  628. package/docs/PatchedSCIMSourcePropertyMappingRequest.md +39 -0
  629. package/docs/PatchedSCIMSourceRequest.md +45 -0
  630. package/docs/PatchedSCIMSourceUserRequest.md +43 -0
  631. package/docs/PatchedSMSDeviceRequest.md +35 -0
  632. package/docs/PatchedSSFProviderRequest.md +41 -0
  633. package/docs/PatchedScheduleRequest.md +38 -0
  634. package/docs/PatchedScopeMappingRequest.md +43 -0
  635. package/docs/PatchedSettingsRequest.md +65 -0
  636. package/docs/PatchedSettingsRequestFlags.md +36 -0
  637. package/docs/PatchedSourceStageRequest.md +39 -0
  638. package/docs/PatchedStaticDeviceRequest.md +35 -0
  639. package/docs/PatchedTOTPDeviceRequest.md +35 -0
  640. package/docs/PatchedTelegramSourcePropertyMappingRequest.md +39 -0
  641. package/docs/PatchedTelegramSourceRequest.md +65 -0
  642. package/docs/PatchedTenantRequest.md +39 -0
  643. package/docs/PatchedTokenRequest.md +47 -0
  644. package/docs/PatchedUniquePasswordPolicyRequest.md +41 -0
  645. package/docs/PatchedUserDeleteStageRequest.md +35 -0
  646. package/docs/PatchedUserKerberosSourceConnectionRequest.md +39 -0
  647. package/docs/PatchedUserLDAPSourceConnectionRequest.md +39 -0
  648. package/docs/PatchedUserLoginStageRequest.md +47 -0
  649. package/docs/PatchedUserLogoutStageRequest.md +35 -0
  650. package/docs/PatchedUserOAuthSourceConnectionRequest.md +43 -0
  651. package/docs/PatchedUserPlexSourceConnectionRequest.md +41 -0
  652. package/docs/PatchedUserRequest.md +53 -0
  653. package/docs/PatchedUserSAMLSourceConnectionRequest.md +39 -0
  654. package/docs/PatchedUserSourceConnectionRequest.md +39 -0
  655. package/docs/PatchedUserTelegramSourceConnectionRequest.md +39 -0
  656. package/docs/PatchedUserWriteStageRequest.md +45 -0
  657. package/docs/PatchedWebAuthnDeviceRequest.md +35 -0
  658. package/docs/Permission.md +47 -0
  659. package/docs/PermissionAssignRequest.md +39 -0
  660. package/docs/PermissionAssignResult.md +35 -0
  661. package/docs/PlexAuthenticationChallenge.md +43 -0
  662. package/docs/PlexAuthenticationChallengeResponseRequest.md +35 -0
  663. package/docs/PlexSource.md +81 -0
  664. package/docs/PlexSourcePropertyMapping.md +49 -0
  665. package/docs/PlexSourcePropertyMappingRequest.md +39 -0
  666. package/docs/PlexSourceRequest.md +67 -0
  667. package/docs/PlexTokenRedeemRequest.md +35 -0
  668. package/docs/PoliciesApi.md +5987 -0
  669. package/docs/Policy.md +49 -0
  670. package/docs/PolicyBinding.md +59 -0
  671. package/docs/PolicyBindingRequest.md +51 -0
  672. package/docs/PolicyEngineMode.md +32 -0
  673. package/docs/PolicyTestRequest.md +37 -0
  674. package/docs/PolicyTestResult.md +39 -0
  675. package/docs/Process.md +38 -0
  676. package/docs/ProcessRequest.md +38 -0
  677. package/docs/Prompt.md +59 -0
  678. package/docs/PromptChallenge.md +41 -0
  679. package/docs/PromptChallengeResponseRequest.md +35 -0
  680. package/docs/PromptChoice.md +37 -0
  681. package/docs/PromptRequest.md +55 -0
  682. package/docs/PromptStage.md +51 -0
  683. package/docs/PromptStageRequest.md +39 -0
  684. package/docs/PromptTypeEnum.md +32 -0
  685. package/docs/PropertyMapping.md +49 -0
  686. package/docs/PropertyMappingPreview.md +35 -0
  687. package/docs/PropertyMappingTestRequest.md +39 -0
  688. package/docs/PropertyMappingTestResult.md +37 -0
  689. package/docs/PropertymappingsApi.md +8604 -0
  690. package/docs/ProtocolEnum.md +32 -0
  691. package/docs/Provider.md +61 -0
  692. package/docs/ProviderEnum.md +32 -0
  693. package/docs/ProviderModelEnum.md +32 -0
  694. package/docs/ProviderTypeEnum.md +32 -0
  695. package/docs/ProvidersApi.md +9144 -0
  696. package/docs/ProxyMode.md +32 -0
  697. package/docs/ProxyOutpostConfig.md +75 -0
  698. package/docs/ProxyProvider.md +97 -0
  699. package/docs/ProxyProviderRequest.md +73 -0
  700. package/docs/RACPropertyMapping.md +51 -0
  701. package/docs/RACPropertyMappingRequest.md +41 -0
  702. package/docs/RACProvider.md +67 -0
  703. package/docs/RACProviderRequest.md +47 -0
  704. package/docs/RacApi.md +1018 -0
  705. package/docs/RadiusCheckAccess.md +37 -0
  706. package/docs/RadiusOutpostConfig.md +49 -0
  707. package/docs/RadiusProvider.md +71 -0
  708. package/docs/RadiusProviderPropertyMapping.md +49 -0
  709. package/docs/RadiusProviderPropertyMappingRequest.md +39 -0
  710. package/docs/RadiusProviderRequest.md +51 -0
  711. package/docs/RbacApi.md +1746 -0
  712. package/docs/RedirectChallenge.md +41 -0
  713. package/docs/RedirectChallengeResponseRequest.md +37 -0
  714. package/docs/RedirectStage.md +55 -0
  715. package/docs/RedirectStageModeEnum.md +32 -0
  716. package/docs/RedirectStageRequest.md +43 -0
  717. package/docs/RedirectURI.md +37 -0
  718. package/docs/RedirectURIRequest.md +37 -0
  719. package/docs/RelatedGroup.md +43 -0
  720. package/docs/ReportsApi.md +233 -0
  721. package/docs/Reputation.md +47 -0
  722. package/docs/ReputationPolicy.md +55 -0
  723. package/docs/ReputationPolicyRequest.md +43 -0
  724. package/docs/ResidentKeyRequirementEnum.md +32 -0
  725. package/docs/Role.md +37 -0
  726. package/docs/RoleAssignedObjectPermission.md +41 -0
  727. package/docs/RoleModelPermission.md +43 -0
  728. package/docs/RoleObjectPermission.md +45 -0
  729. package/docs/RoleRequest.md +35 -0
  730. package/docs/RootApi.md +74 -0
  731. package/docs/SAMLBindingsEnum.md +32 -0
  732. package/docs/SAMLMetadata.md +37 -0
  733. package/docs/SAMLNameIDPolicyEnum.md +32 -0
  734. package/docs/SAMLPropertyMapping.md +53 -0
  735. package/docs/SAMLPropertyMappingRequest.md +43 -0
  736. package/docs/SAMLProvider.md +117 -0
  737. package/docs/SAMLProviderLogoutMethodEnum.md +32 -0
  738. package/docs/SAMLProviderRequest.md +87 -0
  739. package/docs/SAMLSource.md +103 -0
  740. package/docs/SAMLSourcePropertyMapping.md +49 -0
  741. package/docs/SAMLSourcePropertyMappingRequest.md +39 -0
  742. package/docs/SAMLSourceRequest.md +89 -0
  743. package/docs/SCIMAuthenticationModeEnum.md +32 -0
  744. package/docs/SCIMMapping.md +49 -0
  745. package/docs/SCIMMappingRequest.md +39 -0
  746. package/docs/SCIMProvider.md +79 -0
  747. package/docs/SCIMProviderGroup.md +45 -0
  748. package/docs/SCIMProviderGroupRequest.md +39 -0
  749. package/docs/SCIMProviderRequest.md +65 -0
  750. package/docs/SCIMProviderUser.md +45 -0
  751. package/docs/SCIMProviderUserRequest.md +39 -0
  752. package/docs/SCIMSource.md +61 -0
  753. package/docs/SCIMSourceGroup.md +45 -0
  754. package/docs/SCIMSourceGroupRequest.md +43 -0
  755. package/docs/SCIMSourcePropertyMapping.md +49 -0
  756. package/docs/SCIMSourcePropertyMappingRequest.md +39 -0
  757. package/docs/SCIMSourceRequest.md +45 -0
  758. package/docs/SCIMSourceUser.md +45 -0
  759. package/docs/SCIMSourceUserRequest.md +43 -0
  760. package/docs/SMSDevice.md +41 -0
  761. package/docs/SMSDeviceRequest.md +35 -0
  762. package/docs/SSFProvider.md +55 -0
  763. package/docs/SSFProviderRequest.md +41 -0
  764. package/docs/SSFStream.md +51 -0
  765. package/docs/Schedule.md +56 -0
  766. package/docs/ScheduleRequest.md +38 -0
  767. package/docs/SchemaApi.md +85 -0
  768. package/docs/ScopeMapping.md +53 -0
  769. package/docs/ScopeMappingRequest.md +43 -0
  770. package/docs/SelectableStage.md +41 -0
  771. package/docs/ServiceConnection.md +47 -0
  772. package/docs/ServiceConnectionState.md +37 -0
  773. package/docs/SessionEndChallenge.md +51 -0
  774. package/docs/SessionUser.md +37 -0
  775. package/docs/Settings.md +65 -0
  776. package/docs/SettingsRequest.md +65 -0
  777. package/docs/SeverityEnum.md +32 -0
  778. package/docs/ShellChallenge.md +41 -0
  779. package/docs/SignatureAlgorithmEnum.md +32 -0
  780. package/docs/Software.md +40 -0
  781. package/docs/SoftwareRequest.md +40 -0
  782. package/docs/Source.md +71 -0
  783. package/docs/SourceStage.md +51 -0
  784. package/docs/SourceStageRequest.md +39 -0
  785. package/docs/SourceType.md +51 -0
  786. package/docs/SourcesApi.md +13580 -0
  787. package/docs/SsfApi.md +174 -0
  788. package/docs/Stage.md +47 -0
  789. package/docs/StageModeEnum.md +32 -0
  790. package/docs/StagePrompt.md +51 -0
  791. package/docs/StagesApi.md +15798 -0
  792. package/docs/StateEnum.md +32 -0
  793. package/docs/StaticDevice.md +41 -0
  794. package/docs/StaticDeviceRequest.md +35 -0
  795. package/docs/StaticDeviceToken.md +35 -0
  796. package/docs/SubModeEnum.md +32 -0
  797. package/docs/SyncObjectModelEnum.md +32 -0
  798. package/docs/SyncObjectRequest.md +39 -0
  799. package/docs/SyncObjectResult.md +35 -0
  800. package/docs/SyncOutgoingTriggerModeEnum.md +32 -0
  801. package/docs/SyncStatus.md +39 -0
  802. package/docs/SystemInfo.md +49 -0
  803. package/docs/SystemInfoRuntime.md +49 -0
  804. package/docs/TOTPDevice.md +39 -0
  805. package/docs/TOTPDeviceRequest.md +35 -0
  806. package/docs/Task.md +62 -0
  807. package/docs/TaskAggregatedStatusEnum.md +32 -0
  808. package/docs/TasksApi.md +789 -0
  809. package/docs/TelegramAuthRequest.md +46 -0
  810. package/docs/TelegramChallengeResponseRequest.md +49 -0
  811. package/docs/TelegramLoginChallenge.md +43 -0
  812. package/docs/TelegramSource.md +77 -0
  813. package/docs/TelegramSourcePropertyMapping.md +49 -0
  814. package/docs/TelegramSourcePropertyMappingRequest.md +39 -0
  815. package/docs/TelegramSourceRequest.md +65 -0
  816. package/docs/Tenant.md +41 -0
  817. package/docs/TenantAdminGroupRequestRequest.md +35 -0
  818. package/docs/TenantRecoveryKeyRequestRequest.md +37 -0
  819. package/docs/TenantRecoveryKeyResponse.md +37 -0
  820. package/docs/TenantRequest.md +39 -0
  821. package/docs/TenantsApi.md +1026 -0
  822. package/docs/Token.md +51 -0
  823. package/docs/TokenModel.md +49 -0
  824. package/docs/TokenRequest.md +47 -0
  825. package/docs/TokenSetKeyRequest.md +35 -0
  826. package/docs/TokenView.md +35 -0
  827. package/docs/TransactionApplicationRequest.md +41 -0
  828. package/docs/TransactionApplicationResponse.md +37 -0
  829. package/docs/TransactionPolicyBindingRequest.md +49 -0
  830. package/docs/TypeCreate.md +47 -0
  831. package/docs/UiThemeEnum.md +32 -0
  832. package/docs/UniquePasswordPolicy.md +53 -0
  833. package/docs/UniquePasswordPolicyRequest.md +41 -0
  834. package/docs/UsedBy.md +43 -0
  835. package/docs/UsedByActionEnum.md +32 -0
  836. package/docs/User.md +73 -0
  837. package/docs/UserAccountRequest.md +35 -0
  838. package/docs/UserAccountSerializerForRoleRequest.md +35 -0
  839. package/docs/UserAttributeEnum.md +32 -0
  840. package/docs/UserConsent.md +45 -0
  841. package/docs/UserCreationModeEnum.md +32 -0
  842. package/docs/UserDeleteStage.md +47 -0
  843. package/docs/UserDeleteStageRequest.md +35 -0
  844. package/docs/UserFieldsEnum.md +32 -0
  845. package/docs/UserKerberosSourceConnection.md +47 -0
  846. package/docs/UserKerberosSourceConnectionRequest.md +39 -0
  847. package/docs/UserLDAPSourceConnection.md +47 -0
  848. package/docs/UserLDAPSourceConnectionRequest.md +39 -0
  849. package/docs/UserLoginChallenge.md +43 -0
  850. package/docs/UserLoginChallengeResponseRequest.md +37 -0
  851. package/docs/UserLoginStage.md +59 -0
  852. package/docs/UserLoginStageRequest.md +47 -0
  853. package/docs/UserLogoutStage.md +47 -0
  854. package/docs/UserLogoutStageRequest.md +35 -0
  855. package/docs/UserMatchingModeEnum.md +32 -0
  856. package/docs/UserOAuthSourceConnection.md +49 -0
  857. package/docs/UserOAuthSourceConnectionRequest.md +43 -0
  858. package/docs/UserPasswordSetRequest.md +35 -0
  859. package/docs/UserPath.md +34 -0
  860. package/docs/UserPlexSourceConnection.md +47 -0
  861. package/docs/UserPlexSourceConnectionRequest.md +41 -0
  862. package/docs/UserRequest.md +53 -0
  863. package/docs/UserSAMLSourceConnection.md +47 -0
  864. package/docs/UserSAMLSourceConnectionRequest.md +39 -0
  865. package/docs/UserSelf.md +59 -0
  866. package/docs/UserSelfGroups.md +36 -0
  867. package/docs/UserSelfRoles.md +36 -0
  868. package/docs/UserServiceAccountRequest.md +41 -0
  869. package/docs/UserServiceAccountResponse.md +42 -0
  870. package/docs/UserSetting.md +43 -0
  871. package/docs/UserSourceConnection.md +47 -0
  872. package/docs/UserSourceConnectionRequest.md +39 -0
  873. package/docs/UserTelegramSourceConnection.md +47 -0
  874. package/docs/UserTelegramSourceConnectionRequest.md +39 -0
  875. package/docs/UserTypeEnum.md +32 -0
  876. package/docs/UserVerificationEnum.md +32 -0
  877. package/docs/UserWriteStage.md +57 -0
  878. package/docs/UserWriteStageRequest.md +45 -0
  879. package/docs/ValidationError.md +37 -0
  880. package/docs/Version.md +45 -0
  881. package/docs/VersionHistory.md +41 -0
  882. package/docs/WebAuthnDevice.md +45 -0
  883. package/docs/WebAuthnDeviceRequest.md +35 -0
  884. package/docs/WebAuthnDeviceType.md +37 -0
  885. package/docs/Worker.md +38 -0
  886. package/package.json +1 -1
  887. package/src/models/CapabilitiesEnum.ts +1 -0
  888. package/src/models/ContentType.ts +9 -1
  889. package/src/models/DataExport.ts +10 -10
  890. package/src/models/index.ts +0 -1
  891. package/tsconfig.tsbuildinfo +1 -1
  892. package/dist/esm/models/RequestedBy.d.ts +0 -39
  893. package/dist/esm/models/RequestedBy.d.ts.map +0 -1
  894. package/dist/esm/models/RequestedBy.js +0 -54
  895. package/dist/esm/models/RequestedBy.js.map +0 -1
  896. package/dist/models/RequestedBy.d.ts +0 -39
  897. package/dist/models/RequestedBy.d.ts.map +0 -1
  898. package/dist/models/RequestedBy.js +0 -54
  899. package/dist/models/RequestedBy.js.map +0 -1
  900. package/src/models/RequestedBy.ts +0 -74
@@ -0,0 +1,2682 @@
1
+ # OutpostsApi
2
+
3
+ All URIs are relative to */api/v3*
4
+
5
+ | Method | HTTP request | Description |
6
+ |------------- | ------------- | -------------|
7
+ | [**outpostsInstancesCreate**](OutpostsApi.md#outpostsinstancescreate) | **POST** /outposts/instances/ | |
8
+ | [**outpostsInstancesDefaultSettingsRetrieve**](OutpostsApi.md#outpostsinstancesdefaultsettingsretrieve) | **GET** /outposts/instances/default_settings/ | |
9
+ | [**outpostsInstancesDestroy**](OutpostsApi.md#outpostsinstancesdestroy) | **DELETE** /outposts/instances/{uuid}/ | |
10
+ | [**outpostsInstancesHealthList**](OutpostsApi.md#outpostsinstanceshealthlist) | **GET** /outposts/instances/{uuid}/health/ | |
11
+ | [**outpostsInstancesList**](OutpostsApi.md#outpostsinstanceslist) | **GET** /outposts/instances/ | |
12
+ | [**outpostsInstancesPartialUpdate**](OutpostsApi.md#outpostsinstancespartialupdate) | **PATCH** /outposts/instances/{uuid}/ | |
13
+ | [**outpostsInstancesRetrieve**](OutpostsApi.md#outpostsinstancesretrieve) | **GET** /outposts/instances/{uuid}/ | |
14
+ | [**outpostsInstancesUpdate**](OutpostsApi.md#outpostsinstancesupdate) | **PUT** /outposts/instances/{uuid}/ | |
15
+ | [**outpostsInstancesUsedByList**](OutpostsApi.md#outpostsinstancesusedbylist) | **GET** /outposts/instances/{uuid}/used_by/ | |
16
+ | [**outpostsLdapAccessCheck**](OutpostsApi.md#outpostsldapaccesscheck) | **GET** /outposts/ldap/{id}/check_access/ | |
17
+ | [**outpostsLdapList**](OutpostsApi.md#outpostsldaplist) | **GET** /outposts/ldap/ | |
18
+ | [**outpostsProxyList**](OutpostsApi.md#outpostsproxylist) | **GET** /outposts/proxy/ | |
19
+ | [**outpostsRadiusAccessCheck**](OutpostsApi.md#outpostsradiusaccesscheck) | **GET** /outposts/radius/{id}/check_access/ | |
20
+ | [**outpostsRadiusList**](OutpostsApi.md#outpostsradiuslist) | **GET** /outposts/radius/ | |
21
+ | [**outpostsServiceConnectionsAllDestroy**](OutpostsApi.md#outpostsserviceconnectionsalldestroy) | **DELETE** /outposts/service_connections/all/{uuid}/ | |
22
+ | [**outpostsServiceConnectionsAllList**](OutpostsApi.md#outpostsserviceconnectionsalllist) | **GET** /outposts/service_connections/all/ | |
23
+ | [**outpostsServiceConnectionsAllRetrieve**](OutpostsApi.md#outpostsserviceconnectionsallretrieve) | **GET** /outposts/service_connections/all/{uuid}/ | |
24
+ | [**outpostsServiceConnectionsAllStateRetrieve**](OutpostsApi.md#outpostsserviceconnectionsallstateretrieve) | **GET** /outposts/service_connections/all/{uuid}/state/ | |
25
+ | [**outpostsServiceConnectionsAllTypesList**](OutpostsApi.md#outpostsserviceconnectionsalltypeslist) | **GET** /outposts/service_connections/all/types/ | |
26
+ | [**outpostsServiceConnectionsAllUsedByList**](OutpostsApi.md#outpostsserviceconnectionsallusedbylist) | **GET** /outposts/service_connections/all/{uuid}/used_by/ | |
27
+ | [**outpostsServiceConnectionsDockerCreate**](OutpostsApi.md#outpostsserviceconnectionsdockercreate) | **POST** /outposts/service_connections/docker/ | |
28
+ | [**outpostsServiceConnectionsDockerDestroy**](OutpostsApi.md#outpostsserviceconnectionsdockerdestroy) | **DELETE** /outposts/service_connections/docker/{uuid}/ | |
29
+ | [**outpostsServiceConnectionsDockerList**](OutpostsApi.md#outpostsserviceconnectionsdockerlist) | **GET** /outposts/service_connections/docker/ | |
30
+ | [**outpostsServiceConnectionsDockerPartialUpdate**](OutpostsApi.md#outpostsserviceconnectionsdockerpartialupdate) | **PATCH** /outposts/service_connections/docker/{uuid}/ | |
31
+ | [**outpostsServiceConnectionsDockerRetrieve**](OutpostsApi.md#outpostsserviceconnectionsdockerretrieve) | **GET** /outposts/service_connections/docker/{uuid}/ | |
32
+ | [**outpostsServiceConnectionsDockerUpdate**](OutpostsApi.md#outpostsserviceconnectionsdockerupdate) | **PUT** /outposts/service_connections/docker/{uuid}/ | |
33
+ | [**outpostsServiceConnectionsDockerUsedByList**](OutpostsApi.md#outpostsserviceconnectionsdockerusedbylist) | **GET** /outposts/service_connections/docker/{uuid}/used_by/ | |
34
+ | [**outpostsServiceConnectionsKubernetesCreate**](OutpostsApi.md#outpostsserviceconnectionskubernetescreate) | **POST** /outposts/service_connections/kubernetes/ | |
35
+ | [**outpostsServiceConnectionsKubernetesDestroy**](OutpostsApi.md#outpostsserviceconnectionskubernetesdestroy) | **DELETE** /outposts/service_connections/kubernetes/{uuid}/ | |
36
+ | [**outpostsServiceConnectionsKubernetesList**](OutpostsApi.md#outpostsserviceconnectionskuberneteslist) | **GET** /outposts/service_connections/kubernetes/ | |
37
+ | [**outpostsServiceConnectionsKubernetesPartialUpdate**](OutpostsApi.md#outpostsserviceconnectionskubernetespartialupdate) | **PATCH** /outposts/service_connections/kubernetes/{uuid}/ | |
38
+ | [**outpostsServiceConnectionsKubernetesRetrieve**](OutpostsApi.md#outpostsserviceconnectionskubernetesretrieve) | **GET** /outposts/service_connections/kubernetes/{uuid}/ | |
39
+ | [**outpostsServiceConnectionsKubernetesUpdate**](OutpostsApi.md#outpostsserviceconnectionskubernetesupdate) | **PUT** /outposts/service_connections/kubernetes/{uuid}/ | |
40
+ | [**outpostsServiceConnectionsKubernetesUsedByList**](OutpostsApi.md#outpostsserviceconnectionskubernetesusedbylist) | **GET** /outposts/service_connections/kubernetes/{uuid}/used_by/ | |
41
+
42
+
43
+
44
+ ## outpostsInstancesCreate
45
+
46
+ > Outpost outpostsInstancesCreate(outpostRequest)
47
+
48
+
49
+
50
+ Outpost Viewset
51
+
52
+ ### Example
53
+
54
+ ```ts
55
+ import {
56
+ Configuration,
57
+ OutpostsApi,
58
+ } from '@goauthentik/api';
59
+ import type { OutpostsInstancesCreateRequest } from '@goauthentik/api';
60
+
61
+ async function example() {
62
+ console.log("🚀 Testing @goauthentik/api SDK...");
63
+ const config = new Configuration({
64
+ // Configure HTTP bearer authorization: authentik
65
+ accessToken: "YOUR BEARER TOKEN",
66
+ });
67
+ const api = new OutpostsApi(config);
68
+
69
+ const body = {
70
+ // OutpostRequest
71
+ outpostRequest: ...,
72
+ } satisfies OutpostsInstancesCreateRequest;
73
+
74
+ try {
75
+ const data = await api.outpostsInstancesCreate(body);
76
+ console.log(data);
77
+ } catch (error) {
78
+ console.error(error);
79
+ }
80
+ }
81
+
82
+ // Run the test
83
+ example().catch(console.error);
84
+ ```
85
+
86
+ ### Parameters
87
+
88
+
89
+ | Name | Type | Description | Notes |
90
+ |------------- | ------------- | ------------- | -------------|
91
+ | **outpostRequest** | [OutpostRequest](OutpostRequest.md) | | |
92
+
93
+ ### Return type
94
+
95
+ [**Outpost**](Outpost.md)
96
+
97
+ ### Authorization
98
+
99
+ [authentik](../README.md#authentik)
100
+
101
+ ### HTTP request headers
102
+
103
+ - **Content-Type**: `application/json`
104
+ - **Accept**: `application/json`
105
+
106
+
107
+ ### HTTP response details
108
+ | Status code | Description | Response headers |
109
+ |-------------|-------------|------------------|
110
+ | **201** | | - |
111
+ | **400** | | - |
112
+ | **403** | | - |
113
+
114
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
115
+
116
+
117
+ ## outpostsInstancesDefaultSettingsRetrieve
118
+
119
+ > OutpostDefaultConfig outpostsInstancesDefaultSettingsRetrieve()
120
+
121
+
122
+
123
+ Global default outpost config
124
+
125
+ ### Example
126
+
127
+ ```ts
128
+ import {
129
+ Configuration,
130
+ OutpostsApi,
131
+ } from '@goauthentik/api';
132
+ import type { OutpostsInstancesDefaultSettingsRetrieveRequest } from '@goauthentik/api';
133
+
134
+ async function example() {
135
+ console.log("🚀 Testing @goauthentik/api SDK...");
136
+ const config = new Configuration({
137
+ // Configure HTTP bearer authorization: authentik
138
+ accessToken: "YOUR BEARER TOKEN",
139
+ });
140
+ const api = new OutpostsApi(config);
141
+
142
+ try {
143
+ const data = await api.outpostsInstancesDefaultSettingsRetrieve();
144
+ console.log(data);
145
+ } catch (error) {
146
+ console.error(error);
147
+ }
148
+ }
149
+
150
+ // Run the test
151
+ example().catch(console.error);
152
+ ```
153
+
154
+ ### Parameters
155
+
156
+ This endpoint does not need any parameter.
157
+
158
+ ### Return type
159
+
160
+ [**OutpostDefaultConfig**](OutpostDefaultConfig.md)
161
+
162
+ ### Authorization
163
+
164
+ [authentik](../README.md#authentik)
165
+
166
+ ### HTTP request headers
167
+
168
+ - **Content-Type**: Not defined
169
+ - **Accept**: `application/json`
170
+
171
+
172
+ ### HTTP response details
173
+ | Status code | Description | Response headers |
174
+ |-------------|-------------|------------------|
175
+ | **200** | | - |
176
+ | **400** | | - |
177
+ | **403** | | - |
178
+
179
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
180
+
181
+
182
+ ## outpostsInstancesDestroy
183
+
184
+ > outpostsInstancesDestroy(uuid)
185
+
186
+
187
+
188
+ Outpost Viewset
189
+
190
+ ### Example
191
+
192
+ ```ts
193
+ import {
194
+ Configuration,
195
+ OutpostsApi,
196
+ } from '@goauthentik/api';
197
+ import type { OutpostsInstancesDestroyRequest } from '@goauthentik/api';
198
+
199
+ async function example() {
200
+ console.log("🚀 Testing @goauthentik/api SDK...");
201
+ const config = new Configuration({
202
+ // Configure HTTP bearer authorization: authentik
203
+ accessToken: "YOUR BEARER TOKEN",
204
+ });
205
+ const api = new OutpostsApi(config);
206
+
207
+ const body = {
208
+ // string | A UUID string identifying this Outpost.
209
+ uuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
210
+ } satisfies OutpostsInstancesDestroyRequest;
211
+
212
+ try {
213
+ const data = await api.outpostsInstancesDestroy(body);
214
+ console.log(data);
215
+ } catch (error) {
216
+ console.error(error);
217
+ }
218
+ }
219
+
220
+ // Run the test
221
+ example().catch(console.error);
222
+ ```
223
+
224
+ ### Parameters
225
+
226
+
227
+ | Name | Type | Description | Notes |
228
+ |------------- | ------------- | ------------- | -------------|
229
+ | **uuid** | `string` | A UUID string identifying this Outpost. | [Defaults to `undefined`] |
230
+
231
+ ### Return type
232
+
233
+ `void` (Empty response body)
234
+
235
+ ### Authorization
236
+
237
+ [authentik](../README.md#authentik)
238
+
239
+ ### HTTP request headers
240
+
241
+ - **Content-Type**: Not defined
242
+ - **Accept**: `application/json`
243
+
244
+
245
+ ### HTTP response details
246
+ | Status code | Description | Response headers |
247
+ |-------------|-------------|------------------|
248
+ | **204** | No response body | - |
249
+ | **400** | | - |
250
+ | **403** | | - |
251
+
252
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
253
+
254
+
255
+ ## outpostsInstancesHealthList
256
+
257
+ > Array<OutpostHealth> outpostsInstancesHealthList(uuid, managedIcontains, managedIexact, nameIcontains, nameIexact, ordering, providersIsnull, providersByPk, search, serviceConnectionNameIcontains, serviceConnectionNameIexact)
258
+
259
+
260
+
261
+ Get outposts current health
262
+
263
+ ### Example
264
+
265
+ ```ts
266
+ import {
267
+ Configuration,
268
+ OutpostsApi,
269
+ } from '@goauthentik/api';
270
+ import type { OutpostsInstancesHealthListRequest } from '@goauthentik/api';
271
+
272
+ async function example() {
273
+ console.log("🚀 Testing @goauthentik/api SDK...");
274
+ const config = new Configuration({
275
+ // Configure HTTP bearer authorization: authentik
276
+ accessToken: "YOUR BEARER TOKEN",
277
+ });
278
+ const api = new OutpostsApi(config);
279
+
280
+ const body = {
281
+ // string | A UUID string identifying this Outpost.
282
+ uuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
283
+ // string (optional)
284
+ managedIcontains: managedIcontains_example,
285
+ // string (optional)
286
+ managedIexact: managedIexact_example,
287
+ // string (optional)
288
+ nameIcontains: nameIcontains_example,
289
+ // string (optional)
290
+ nameIexact: nameIexact_example,
291
+ // string | Which field to use when ordering the results. (optional)
292
+ ordering: ordering_example,
293
+ // boolean (optional)
294
+ providersIsnull: true,
295
+ // Array<number> (optional)
296
+ providersByPk: ...,
297
+ // string | A search term. (optional)
298
+ search: search_example,
299
+ // string (optional)
300
+ serviceConnectionNameIcontains: serviceConnectionNameIcontains_example,
301
+ // string (optional)
302
+ serviceConnectionNameIexact: serviceConnectionNameIexact_example,
303
+ } satisfies OutpostsInstancesHealthListRequest;
304
+
305
+ try {
306
+ const data = await api.outpostsInstancesHealthList(body);
307
+ console.log(data);
308
+ } catch (error) {
309
+ console.error(error);
310
+ }
311
+ }
312
+
313
+ // Run the test
314
+ example().catch(console.error);
315
+ ```
316
+
317
+ ### Parameters
318
+
319
+
320
+ | Name | Type | Description | Notes |
321
+ |------------- | ------------- | ------------- | -------------|
322
+ | **uuid** | `string` | A UUID string identifying this Outpost. | [Defaults to `undefined`] |
323
+ | **managedIcontains** | `string` | | [Optional] [Defaults to `undefined`] |
324
+ | **managedIexact** | `string` | | [Optional] [Defaults to `undefined`] |
325
+ | **nameIcontains** | `string` | | [Optional] [Defaults to `undefined`] |
326
+ | **nameIexact** | `string` | | [Optional] [Defaults to `undefined`] |
327
+ | **ordering** | `string` | Which field to use when ordering the results. | [Optional] [Defaults to `undefined`] |
328
+ | **providersIsnull** | `boolean` | | [Optional] [Defaults to `undefined`] |
329
+ | **providersByPk** | `Array<number>` | | [Optional] |
330
+ | **search** | `string` | A search term. | [Optional] [Defaults to `undefined`] |
331
+ | **serviceConnectionNameIcontains** | `string` | | [Optional] [Defaults to `undefined`] |
332
+ | **serviceConnectionNameIexact** | `string` | | [Optional] [Defaults to `undefined`] |
333
+
334
+ ### Return type
335
+
336
+ [**Array&lt;OutpostHealth&gt;**](OutpostHealth.md)
337
+
338
+ ### Authorization
339
+
340
+ [authentik](../README.md#authentik)
341
+
342
+ ### HTTP request headers
343
+
344
+ - **Content-Type**: Not defined
345
+ - **Accept**: `application/json`
346
+
347
+
348
+ ### HTTP response details
349
+ | Status code | Description | Response headers |
350
+ |-------------|-------------|------------------|
351
+ | **200** | | - |
352
+ | **400** | | - |
353
+ | **403** | | - |
354
+
355
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
356
+
357
+
358
+ ## outpostsInstancesList
359
+
360
+ > PaginatedOutpostList outpostsInstancesList(managedIcontains, managedIexact, nameIcontains, nameIexact, ordering, page, pageSize, providersIsnull, providersByPk, search, serviceConnectionNameIcontains, serviceConnectionNameIexact)
361
+
362
+
363
+
364
+ Outpost Viewset
365
+
366
+ ### Example
367
+
368
+ ```ts
369
+ import {
370
+ Configuration,
371
+ OutpostsApi,
372
+ } from '@goauthentik/api';
373
+ import type { OutpostsInstancesListRequest } from '@goauthentik/api';
374
+
375
+ async function example() {
376
+ console.log("🚀 Testing @goauthentik/api SDK...");
377
+ const config = new Configuration({
378
+ // Configure HTTP bearer authorization: authentik
379
+ accessToken: "YOUR BEARER TOKEN",
380
+ });
381
+ const api = new OutpostsApi(config);
382
+
383
+ const body = {
384
+ // string (optional)
385
+ managedIcontains: managedIcontains_example,
386
+ // string (optional)
387
+ managedIexact: managedIexact_example,
388
+ // string (optional)
389
+ nameIcontains: nameIcontains_example,
390
+ // string (optional)
391
+ nameIexact: nameIexact_example,
392
+ // string | Which field to use when ordering the results. (optional)
393
+ ordering: ordering_example,
394
+ // number | A page number within the paginated result set. (optional)
395
+ page: 56,
396
+ // number | Number of results to return per page. (optional)
397
+ pageSize: 56,
398
+ // boolean (optional)
399
+ providersIsnull: true,
400
+ // Array<number> (optional)
401
+ providersByPk: ...,
402
+ // string | A search term. (optional)
403
+ search: search_example,
404
+ // string (optional)
405
+ serviceConnectionNameIcontains: serviceConnectionNameIcontains_example,
406
+ // string (optional)
407
+ serviceConnectionNameIexact: serviceConnectionNameIexact_example,
408
+ } satisfies OutpostsInstancesListRequest;
409
+
410
+ try {
411
+ const data = await api.outpostsInstancesList(body);
412
+ console.log(data);
413
+ } catch (error) {
414
+ console.error(error);
415
+ }
416
+ }
417
+
418
+ // Run the test
419
+ example().catch(console.error);
420
+ ```
421
+
422
+ ### Parameters
423
+
424
+
425
+ | Name | Type | Description | Notes |
426
+ |------------- | ------------- | ------------- | -------------|
427
+ | **managedIcontains** | `string` | | [Optional] [Defaults to `undefined`] |
428
+ | **managedIexact** | `string` | | [Optional] [Defaults to `undefined`] |
429
+ | **nameIcontains** | `string` | | [Optional] [Defaults to `undefined`] |
430
+ | **nameIexact** | `string` | | [Optional] [Defaults to `undefined`] |
431
+ | **ordering** | `string` | Which field to use when ordering the results. | [Optional] [Defaults to `undefined`] |
432
+ | **page** | `number` | A page number within the paginated result set. | [Optional] [Defaults to `undefined`] |
433
+ | **pageSize** | `number` | Number of results to return per page. | [Optional] [Defaults to `undefined`] |
434
+ | **providersIsnull** | `boolean` | | [Optional] [Defaults to `undefined`] |
435
+ | **providersByPk** | `Array<number>` | | [Optional] |
436
+ | **search** | `string` | A search term. | [Optional] [Defaults to `undefined`] |
437
+ | **serviceConnectionNameIcontains** | `string` | | [Optional] [Defaults to `undefined`] |
438
+ | **serviceConnectionNameIexact** | `string` | | [Optional] [Defaults to `undefined`] |
439
+
440
+ ### Return type
441
+
442
+ [**PaginatedOutpostList**](PaginatedOutpostList.md)
443
+
444
+ ### Authorization
445
+
446
+ [authentik](../README.md#authentik)
447
+
448
+ ### HTTP request headers
449
+
450
+ - **Content-Type**: Not defined
451
+ - **Accept**: `application/json`
452
+
453
+
454
+ ### HTTP response details
455
+ | Status code | Description | Response headers |
456
+ |-------------|-------------|------------------|
457
+ | **200** | | - |
458
+ | **400** | | - |
459
+ | **403** | | - |
460
+
461
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
462
+
463
+
464
+ ## outpostsInstancesPartialUpdate
465
+
466
+ > Outpost outpostsInstancesPartialUpdate(uuid, patchedOutpostRequest)
467
+
468
+
469
+
470
+ Outpost Viewset
471
+
472
+ ### Example
473
+
474
+ ```ts
475
+ import {
476
+ Configuration,
477
+ OutpostsApi,
478
+ } from '@goauthentik/api';
479
+ import type { OutpostsInstancesPartialUpdateRequest } from '@goauthentik/api';
480
+
481
+ async function example() {
482
+ console.log("🚀 Testing @goauthentik/api SDK...");
483
+ const config = new Configuration({
484
+ // Configure HTTP bearer authorization: authentik
485
+ accessToken: "YOUR BEARER TOKEN",
486
+ });
487
+ const api = new OutpostsApi(config);
488
+
489
+ const body = {
490
+ // string | A UUID string identifying this Outpost.
491
+ uuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
492
+ // PatchedOutpostRequest (optional)
493
+ patchedOutpostRequest: ...,
494
+ } satisfies OutpostsInstancesPartialUpdateRequest;
495
+
496
+ try {
497
+ const data = await api.outpostsInstancesPartialUpdate(body);
498
+ console.log(data);
499
+ } catch (error) {
500
+ console.error(error);
501
+ }
502
+ }
503
+
504
+ // Run the test
505
+ example().catch(console.error);
506
+ ```
507
+
508
+ ### Parameters
509
+
510
+
511
+ | Name | Type | Description | Notes |
512
+ |------------- | ------------- | ------------- | -------------|
513
+ | **uuid** | `string` | A UUID string identifying this Outpost. | [Defaults to `undefined`] |
514
+ | **patchedOutpostRequest** | [PatchedOutpostRequest](PatchedOutpostRequest.md) | | [Optional] |
515
+
516
+ ### Return type
517
+
518
+ [**Outpost**](Outpost.md)
519
+
520
+ ### Authorization
521
+
522
+ [authentik](../README.md#authentik)
523
+
524
+ ### HTTP request headers
525
+
526
+ - **Content-Type**: `application/json`
527
+ - **Accept**: `application/json`
528
+
529
+
530
+ ### HTTP response details
531
+ | Status code | Description | Response headers |
532
+ |-------------|-------------|------------------|
533
+ | **200** | | - |
534
+ | **400** | | - |
535
+ | **403** | | - |
536
+
537
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
538
+
539
+
540
+ ## outpostsInstancesRetrieve
541
+
542
+ > Outpost outpostsInstancesRetrieve(uuid)
543
+
544
+
545
+
546
+ Outpost Viewset
547
+
548
+ ### Example
549
+
550
+ ```ts
551
+ import {
552
+ Configuration,
553
+ OutpostsApi,
554
+ } from '@goauthentik/api';
555
+ import type { OutpostsInstancesRetrieveRequest } from '@goauthentik/api';
556
+
557
+ async function example() {
558
+ console.log("🚀 Testing @goauthentik/api SDK...");
559
+ const config = new Configuration({
560
+ // Configure HTTP bearer authorization: authentik
561
+ accessToken: "YOUR BEARER TOKEN",
562
+ });
563
+ const api = new OutpostsApi(config);
564
+
565
+ const body = {
566
+ // string | A UUID string identifying this Outpost.
567
+ uuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
568
+ } satisfies OutpostsInstancesRetrieveRequest;
569
+
570
+ try {
571
+ const data = await api.outpostsInstancesRetrieve(body);
572
+ console.log(data);
573
+ } catch (error) {
574
+ console.error(error);
575
+ }
576
+ }
577
+
578
+ // Run the test
579
+ example().catch(console.error);
580
+ ```
581
+
582
+ ### Parameters
583
+
584
+
585
+ | Name | Type | Description | Notes |
586
+ |------------- | ------------- | ------------- | -------------|
587
+ | **uuid** | `string` | A UUID string identifying this Outpost. | [Defaults to `undefined`] |
588
+
589
+ ### Return type
590
+
591
+ [**Outpost**](Outpost.md)
592
+
593
+ ### Authorization
594
+
595
+ [authentik](../README.md#authentik)
596
+
597
+ ### HTTP request headers
598
+
599
+ - **Content-Type**: Not defined
600
+ - **Accept**: `application/json`
601
+
602
+
603
+ ### HTTP response details
604
+ | Status code | Description | Response headers |
605
+ |-------------|-------------|------------------|
606
+ | **200** | | - |
607
+ | **400** | | - |
608
+ | **403** | | - |
609
+
610
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
611
+
612
+
613
+ ## outpostsInstancesUpdate
614
+
615
+ > Outpost outpostsInstancesUpdate(uuid, outpostRequest)
616
+
617
+
618
+
619
+ Outpost Viewset
620
+
621
+ ### Example
622
+
623
+ ```ts
624
+ import {
625
+ Configuration,
626
+ OutpostsApi,
627
+ } from '@goauthentik/api';
628
+ import type { OutpostsInstancesUpdateRequest } from '@goauthentik/api';
629
+
630
+ async function example() {
631
+ console.log("🚀 Testing @goauthentik/api SDK...");
632
+ const config = new Configuration({
633
+ // Configure HTTP bearer authorization: authentik
634
+ accessToken: "YOUR BEARER TOKEN",
635
+ });
636
+ const api = new OutpostsApi(config);
637
+
638
+ const body = {
639
+ // string | A UUID string identifying this Outpost.
640
+ uuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
641
+ // OutpostRequest
642
+ outpostRequest: ...,
643
+ } satisfies OutpostsInstancesUpdateRequest;
644
+
645
+ try {
646
+ const data = await api.outpostsInstancesUpdate(body);
647
+ console.log(data);
648
+ } catch (error) {
649
+ console.error(error);
650
+ }
651
+ }
652
+
653
+ // Run the test
654
+ example().catch(console.error);
655
+ ```
656
+
657
+ ### Parameters
658
+
659
+
660
+ | Name | Type | Description | Notes |
661
+ |------------- | ------------- | ------------- | -------------|
662
+ | **uuid** | `string` | A UUID string identifying this Outpost. | [Defaults to `undefined`] |
663
+ | **outpostRequest** | [OutpostRequest](OutpostRequest.md) | | |
664
+
665
+ ### Return type
666
+
667
+ [**Outpost**](Outpost.md)
668
+
669
+ ### Authorization
670
+
671
+ [authentik](../README.md#authentik)
672
+
673
+ ### HTTP request headers
674
+
675
+ - **Content-Type**: `application/json`
676
+ - **Accept**: `application/json`
677
+
678
+
679
+ ### HTTP response details
680
+ | Status code | Description | Response headers |
681
+ |-------------|-------------|------------------|
682
+ | **200** | | - |
683
+ | **400** | | - |
684
+ | **403** | | - |
685
+
686
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
687
+
688
+
689
+ ## outpostsInstancesUsedByList
690
+
691
+ > Array&lt;UsedBy&gt; outpostsInstancesUsedByList(uuid)
692
+
693
+
694
+
695
+ Get a list of all objects that use this object
696
+
697
+ ### Example
698
+
699
+ ```ts
700
+ import {
701
+ Configuration,
702
+ OutpostsApi,
703
+ } from '@goauthentik/api';
704
+ import type { OutpostsInstancesUsedByListRequest } from '@goauthentik/api';
705
+
706
+ async function example() {
707
+ console.log("🚀 Testing @goauthentik/api SDK...");
708
+ const config = new Configuration({
709
+ // Configure HTTP bearer authorization: authentik
710
+ accessToken: "YOUR BEARER TOKEN",
711
+ });
712
+ const api = new OutpostsApi(config);
713
+
714
+ const body = {
715
+ // string | A UUID string identifying this Outpost.
716
+ uuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
717
+ } satisfies OutpostsInstancesUsedByListRequest;
718
+
719
+ try {
720
+ const data = await api.outpostsInstancesUsedByList(body);
721
+ console.log(data);
722
+ } catch (error) {
723
+ console.error(error);
724
+ }
725
+ }
726
+
727
+ // Run the test
728
+ example().catch(console.error);
729
+ ```
730
+
731
+ ### Parameters
732
+
733
+
734
+ | Name | Type | Description | Notes |
735
+ |------------- | ------------- | ------------- | -------------|
736
+ | **uuid** | `string` | A UUID string identifying this Outpost. | [Defaults to `undefined`] |
737
+
738
+ ### Return type
739
+
740
+ [**Array&lt;UsedBy&gt;**](UsedBy.md)
741
+
742
+ ### Authorization
743
+
744
+ [authentik](../README.md#authentik)
745
+
746
+ ### HTTP request headers
747
+
748
+ - **Content-Type**: Not defined
749
+ - **Accept**: `application/json`
750
+
751
+
752
+ ### HTTP response details
753
+ | Status code | Description | Response headers |
754
+ |-------------|-------------|------------------|
755
+ | **200** | | - |
756
+ | **400** | | - |
757
+ | **403** | | - |
758
+
759
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
760
+
761
+
762
+ ## outpostsLdapAccessCheck
763
+
764
+ > LDAPCheckAccess outpostsLdapAccessCheck(id, appSlug)
765
+
766
+
767
+
768
+ Check access to a single application by slug
769
+
770
+ ### Example
771
+
772
+ ```ts
773
+ import {
774
+ Configuration,
775
+ OutpostsApi,
776
+ } from '@goauthentik/api';
777
+ import type { OutpostsLdapAccessCheckRequest } from '@goauthentik/api';
778
+
779
+ async function example() {
780
+ console.log("🚀 Testing @goauthentik/api SDK...");
781
+ const config = new Configuration({
782
+ // Configure HTTP bearer authorization: authentik
783
+ accessToken: "YOUR BEARER TOKEN",
784
+ });
785
+ const api = new OutpostsApi(config);
786
+
787
+ const body = {
788
+ // number | A unique integer value identifying this LDAP Provider.
789
+ id: 56,
790
+ // string (optional)
791
+ appSlug: appSlug_example,
792
+ } satisfies OutpostsLdapAccessCheckRequest;
793
+
794
+ try {
795
+ const data = await api.outpostsLdapAccessCheck(body);
796
+ console.log(data);
797
+ } catch (error) {
798
+ console.error(error);
799
+ }
800
+ }
801
+
802
+ // Run the test
803
+ example().catch(console.error);
804
+ ```
805
+
806
+ ### Parameters
807
+
808
+
809
+ | Name | Type | Description | Notes |
810
+ |------------- | ------------- | ------------- | -------------|
811
+ | **id** | `number` | A unique integer value identifying this LDAP Provider. | [Defaults to `undefined`] |
812
+ | **appSlug** | `string` | | [Optional] [Defaults to `undefined`] |
813
+
814
+ ### Return type
815
+
816
+ [**LDAPCheckAccess**](LDAPCheckAccess.md)
817
+
818
+ ### Authorization
819
+
820
+ [authentik](../README.md#authentik)
821
+
822
+ ### HTTP request headers
823
+
824
+ - **Content-Type**: Not defined
825
+ - **Accept**: `application/json`
826
+
827
+
828
+ ### HTTP response details
829
+ | Status code | Description | Response headers |
830
+ |-------------|-------------|------------------|
831
+ | **200** | | - |
832
+ | **400** | | - |
833
+ | **403** | | - |
834
+
835
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
836
+
837
+
838
+ ## outpostsLdapList
839
+
840
+ > PaginatedLDAPOutpostConfigList outpostsLdapList(name, ordering, page, pageSize, search)
841
+
842
+
843
+
844
+ LDAPProvider Viewset
845
+
846
+ ### Example
847
+
848
+ ```ts
849
+ import {
850
+ Configuration,
851
+ OutpostsApi,
852
+ } from '@goauthentik/api';
853
+ import type { OutpostsLdapListRequest } from '@goauthentik/api';
854
+
855
+ async function example() {
856
+ console.log("🚀 Testing @goauthentik/api SDK...");
857
+ const config = new Configuration({
858
+ // Configure HTTP bearer authorization: authentik
859
+ accessToken: "YOUR BEARER TOKEN",
860
+ });
861
+ const api = new OutpostsApi(config);
862
+
863
+ const body = {
864
+ // string (optional)
865
+ name: name_example,
866
+ // string | Which field to use when ordering the results. (optional)
867
+ ordering: ordering_example,
868
+ // number | A page number within the paginated result set. (optional)
869
+ page: 56,
870
+ // number | Number of results to return per page. (optional)
871
+ pageSize: 56,
872
+ // string | A search term. (optional)
873
+ search: search_example,
874
+ } satisfies OutpostsLdapListRequest;
875
+
876
+ try {
877
+ const data = await api.outpostsLdapList(body);
878
+ console.log(data);
879
+ } catch (error) {
880
+ console.error(error);
881
+ }
882
+ }
883
+
884
+ // Run the test
885
+ example().catch(console.error);
886
+ ```
887
+
888
+ ### Parameters
889
+
890
+
891
+ | Name | Type | Description | Notes |
892
+ |------------- | ------------- | ------------- | -------------|
893
+ | **name** | `string` | | [Optional] [Defaults to `undefined`] |
894
+ | **ordering** | `string` | Which field to use when ordering the results. | [Optional] [Defaults to `undefined`] |
895
+ | **page** | `number` | A page number within the paginated result set. | [Optional] [Defaults to `undefined`] |
896
+ | **pageSize** | `number` | Number of results to return per page. | [Optional] [Defaults to `undefined`] |
897
+ | **search** | `string` | A search term. | [Optional] [Defaults to `undefined`] |
898
+
899
+ ### Return type
900
+
901
+ [**PaginatedLDAPOutpostConfigList**](PaginatedLDAPOutpostConfigList.md)
902
+
903
+ ### Authorization
904
+
905
+ [authentik](../README.md#authentik)
906
+
907
+ ### HTTP request headers
908
+
909
+ - **Content-Type**: Not defined
910
+ - **Accept**: `application/json`
911
+
912
+
913
+ ### HTTP response details
914
+ | Status code | Description | Response headers |
915
+ |-------------|-------------|------------------|
916
+ | **200** | | - |
917
+ | **400** | | - |
918
+ | **403** | | - |
919
+
920
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
921
+
922
+
923
+ ## outpostsProxyList
924
+
925
+ > PaginatedProxyOutpostConfigList outpostsProxyList(name, ordering, page, pageSize, search)
926
+
927
+
928
+
929
+ ProxyProvider Viewset
930
+
931
+ ### Example
932
+
933
+ ```ts
934
+ import {
935
+ Configuration,
936
+ OutpostsApi,
937
+ } from '@goauthentik/api';
938
+ import type { OutpostsProxyListRequest } from '@goauthentik/api';
939
+
940
+ async function example() {
941
+ console.log("🚀 Testing @goauthentik/api SDK...");
942
+ const config = new Configuration({
943
+ // Configure HTTP bearer authorization: authentik
944
+ accessToken: "YOUR BEARER TOKEN",
945
+ });
946
+ const api = new OutpostsApi(config);
947
+
948
+ const body = {
949
+ // string (optional)
950
+ name: name_example,
951
+ // string | Which field to use when ordering the results. (optional)
952
+ ordering: ordering_example,
953
+ // number | A page number within the paginated result set. (optional)
954
+ page: 56,
955
+ // number | Number of results to return per page. (optional)
956
+ pageSize: 56,
957
+ // string | A search term. (optional)
958
+ search: search_example,
959
+ } satisfies OutpostsProxyListRequest;
960
+
961
+ try {
962
+ const data = await api.outpostsProxyList(body);
963
+ console.log(data);
964
+ } catch (error) {
965
+ console.error(error);
966
+ }
967
+ }
968
+
969
+ // Run the test
970
+ example().catch(console.error);
971
+ ```
972
+
973
+ ### Parameters
974
+
975
+
976
+ | Name | Type | Description | Notes |
977
+ |------------- | ------------- | ------------- | -------------|
978
+ | **name** | `string` | | [Optional] [Defaults to `undefined`] |
979
+ | **ordering** | `string` | Which field to use when ordering the results. | [Optional] [Defaults to `undefined`] |
980
+ | **page** | `number` | A page number within the paginated result set. | [Optional] [Defaults to `undefined`] |
981
+ | **pageSize** | `number` | Number of results to return per page. | [Optional] [Defaults to `undefined`] |
982
+ | **search** | `string` | A search term. | [Optional] [Defaults to `undefined`] |
983
+
984
+ ### Return type
985
+
986
+ [**PaginatedProxyOutpostConfigList**](PaginatedProxyOutpostConfigList.md)
987
+
988
+ ### Authorization
989
+
990
+ [authentik](../README.md#authentik)
991
+
992
+ ### HTTP request headers
993
+
994
+ - **Content-Type**: Not defined
995
+ - **Accept**: `application/json`
996
+
997
+
998
+ ### HTTP response details
999
+ | Status code | Description | Response headers |
1000
+ |-------------|-------------|------------------|
1001
+ | **200** | | - |
1002
+ | **400** | | - |
1003
+ | **403** | | - |
1004
+
1005
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1006
+
1007
+
1008
+ ## outpostsRadiusAccessCheck
1009
+
1010
+ > RadiusCheckAccess outpostsRadiusAccessCheck(id, appSlug)
1011
+
1012
+
1013
+
1014
+ Check access to a single application by slug
1015
+
1016
+ ### Example
1017
+
1018
+ ```ts
1019
+ import {
1020
+ Configuration,
1021
+ OutpostsApi,
1022
+ } from '@goauthentik/api';
1023
+ import type { OutpostsRadiusAccessCheckRequest } from '@goauthentik/api';
1024
+
1025
+ async function example() {
1026
+ console.log("🚀 Testing @goauthentik/api SDK...");
1027
+ const config = new Configuration({
1028
+ // Configure HTTP bearer authorization: authentik
1029
+ accessToken: "YOUR BEARER TOKEN",
1030
+ });
1031
+ const api = new OutpostsApi(config);
1032
+
1033
+ const body = {
1034
+ // number | A unique integer value identifying this Radius Provider.
1035
+ id: 56,
1036
+ // string (optional)
1037
+ appSlug: appSlug_example,
1038
+ } satisfies OutpostsRadiusAccessCheckRequest;
1039
+
1040
+ try {
1041
+ const data = await api.outpostsRadiusAccessCheck(body);
1042
+ console.log(data);
1043
+ } catch (error) {
1044
+ console.error(error);
1045
+ }
1046
+ }
1047
+
1048
+ // Run the test
1049
+ example().catch(console.error);
1050
+ ```
1051
+
1052
+ ### Parameters
1053
+
1054
+
1055
+ | Name | Type | Description | Notes |
1056
+ |------------- | ------------- | ------------- | -------------|
1057
+ | **id** | `number` | A unique integer value identifying this Radius Provider. | [Defaults to `undefined`] |
1058
+ | **appSlug** | `string` | | [Optional] [Defaults to `undefined`] |
1059
+
1060
+ ### Return type
1061
+
1062
+ [**RadiusCheckAccess**](RadiusCheckAccess.md)
1063
+
1064
+ ### Authorization
1065
+
1066
+ [authentik](../README.md#authentik)
1067
+
1068
+ ### HTTP request headers
1069
+
1070
+ - **Content-Type**: Not defined
1071
+ - **Accept**: `application/json`
1072
+
1073
+
1074
+ ### HTTP response details
1075
+ | Status code | Description | Response headers |
1076
+ |-------------|-------------|------------------|
1077
+ | **200** | | - |
1078
+ | **400** | | - |
1079
+ | **403** | | - |
1080
+
1081
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1082
+
1083
+
1084
+ ## outpostsRadiusList
1085
+
1086
+ > PaginatedRadiusOutpostConfigList outpostsRadiusList(name, ordering, page, pageSize, search)
1087
+
1088
+
1089
+
1090
+ RadiusProvider Viewset
1091
+
1092
+ ### Example
1093
+
1094
+ ```ts
1095
+ import {
1096
+ Configuration,
1097
+ OutpostsApi,
1098
+ } from '@goauthentik/api';
1099
+ import type { OutpostsRadiusListRequest } from '@goauthentik/api';
1100
+
1101
+ async function example() {
1102
+ console.log("🚀 Testing @goauthentik/api SDK...");
1103
+ const config = new Configuration({
1104
+ // Configure HTTP bearer authorization: authentik
1105
+ accessToken: "YOUR BEARER TOKEN",
1106
+ });
1107
+ const api = new OutpostsApi(config);
1108
+
1109
+ const body = {
1110
+ // string (optional)
1111
+ name: name_example,
1112
+ // string | Which field to use when ordering the results. (optional)
1113
+ ordering: ordering_example,
1114
+ // number | A page number within the paginated result set. (optional)
1115
+ page: 56,
1116
+ // number | Number of results to return per page. (optional)
1117
+ pageSize: 56,
1118
+ // string | A search term. (optional)
1119
+ search: search_example,
1120
+ } satisfies OutpostsRadiusListRequest;
1121
+
1122
+ try {
1123
+ const data = await api.outpostsRadiusList(body);
1124
+ console.log(data);
1125
+ } catch (error) {
1126
+ console.error(error);
1127
+ }
1128
+ }
1129
+
1130
+ // Run the test
1131
+ example().catch(console.error);
1132
+ ```
1133
+
1134
+ ### Parameters
1135
+
1136
+
1137
+ | Name | Type | Description | Notes |
1138
+ |------------- | ------------- | ------------- | -------------|
1139
+ | **name** | `string` | | [Optional] [Defaults to `undefined`] |
1140
+ | **ordering** | `string` | Which field to use when ordering the results. | [Optional] [Defaults to `undefined`] |
1141
+ | **page** | `number` | A page number within the paginated result set. | [Optional] [Defaults to `undefined`] |
1142
+ | **pageSize** | `number` | Number of results to return per page. | [Optional] [Defaults to `undefined`] |
1143
+ | **search** | `string` | A search term. | [Optional] [Defaults to `undefined`] |
1144
+
1145
+ ### Return type
1146
+
1147
+ [**PaginatedRadiusOutpostConfigList**](PaginatedRadiusOutpostConfigList.md)
1148
+
1149
+ ### Authorization
1150
+
1151
+ [authentik](../README.md#authentik)
1152
+
1153
+ ### HTTP request headers
1154
+
1155
+ - **Content-Type**: Not defined
1156
+ - **Accept**: `application/json`
1157
+
1158
+
1159
+ ### HTTP response details
1160
+ | Status code | Description | Response headers |
1161
+ |-------------|-------------|------------------|
1162
+ | **200** | | - |
1163
+ | **400** | | - |
1164
+ | **403** | | - |
1165
+
1166
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1167
+
1168
+
1169
+ ## outpostsServiceConnectionsAllDestroy
1170
+
1171
+ > outpostsServiceConnectionsAllDestroy(uuid)
1172
+
1173
+
1174
+
1175
+ ServiceConnection Viewset
1176
+
1177
+ ### Example
1178
+
1179
+ ```ts
1180
+ import {
1181
+ Configuration,
1182
+ OutpostsApi,
1183
+ } from '@goauthentik/api';
1184
+ import type { OutpostsServiceConnectionsAllDestroyRequest } from '@goauthentik/api';
1185
+
1186
+ async function example() {
1187
+ console.log("🚀 Testing @goauthentik/api SDK...");
1188
+ const config = new Configuration({
1189
+ // Configure HTTP bearer authorization: authentik
1190
+ accessToken: "YOUR BEARER TOKEN",
1191
+ });
1192
+ const api = new OutpostsApi(config);
1193
+
1194
+ const body = {
1195
+ // string | A UUID string identifying this Outpost Service-Connection.
1196
+ uuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1197
+ } satisfies OutpostsServiceConnectionsAllDestroyRequest;
1198
+
1199
+ try {
1200
+ const data = await api.outpostsServiceConnectionsAllDestroy(body);
1201
+ console.log(data);
1202
+ } catch (error) {
1203
+ console.error(error);
1204
+ }
1205
+ }
1206
+
1207
+ // Run the test
1208
+ example().catch(console.error);
1209
+ ```
1210
+
1211
+ ### Parameters
1212
+
1213
+
1214
+ | Name | Type | Description | Notes |
1215
+ |------------- | ------------- | ------------- | -------------|
1216
+ | **uuid** | `string` | A UUID string identifying this Outpost Service-Connection. | [Defaults to `undefined`] |
1217
+
1218
+ ### Return type
1219
+
1220
+ `void` (Empty response body)
1221
+
1222
+ ### Authorization
1223
+
1224
+ [authentik](../README.md#authentik)
1225
+
1226
+ ### HTTP request headers
1227
+
1228
+ - **Content-Type**: Not defined
1229
+ - **Accept**: `application/json`
1230
+
1231
+
1232
+ ### HTTP response details
1233
+ | Status code | Description | Response headers |
1234
+ |-------------|-------------|------------------|
1235
+ | **204** | No response body | - |
1236
+ | **400** | | - |
1237
+ | **403** | | - |
1238
+
1239
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1240
+
1241
+
1242
+ ## outpostsServiceConnectionsAllList
1243
+
1244
+ > PaginatedServiceConnectionList outpostsServiceConnectionsAllList(name, ordering, page, pageSize, search)
1245
+
1246
+
1247
+
1248
+ ServiceConnection Viewset
1249
+
1250
+ ### Example
1251
+
1252
+ ```ts
1253
+ import {
1254
+ Configuration,
1255
+ OutpostsApi,
1256
+ } from '@goauthentik/api';
1257
+ import type { OutpostsServiceConnectionsAllListRequest } from '@goauthentik/api';
1258
+
1259
+ async function example() {
1260
+ console.log("🚀 Testing @goauthentik/api SDK...");
1261
+ const config = new Configuration({
1262
+ // Configure HTTP bearer authorization: authentik
1263
+ accessToken: "YOUR BEARER TOKEN",
1264
+ });
1265
+ const api = new OutpostsApi(config);
1266
+
1267
+ const body = {
1268
+ // string (optional)
1269
+ name: name_example,
1270
+ // string | Which field to use when ordering the results. (optional)
1271
+ ordering: ordering_example,
1272
+ // number | A page number within the paginated result set. (optional)
1273
+ page: 56,
1274
+ // number | Number of results to return per page. (optional)
1275
+ pageSize: 56,
1276
+ // string | A search term. (optional)
1277
+ search: search_example,
1278
+ } satisfies OutpostsServiceConnectionsAllListRequest;
1279
+
1280
+ try {
1281
+ const data = await api.outpostsServiceConnectionsAllList(body);
1282
+ console.log(data);
1283
+ } catch (error) {
1284
+ console.error(error);
1285
+ }
1286
+ }
1287
+
1288
+ // Run the test
1289
+ example().catch(console.error);
1290
+ ```
1291
+
1292
+ ### Parameters
1293
+
1294
+
1295
+ | Name | Type | Description | Notes |
1296
+ |------------- | ------------- | ------------- | -------------|
1297
+ | **name** | `string` | | [Optional] [Defaults to `undefined`] |
1298
+ | **ordering** | `string` | Which field to use when ordering the results. | [Optional] [Defaults to `undefined`] |
1299
+ | **page** | `number` | A page number within the paginated result set. | [Optional] [Defaults to `undefined`] |
1300
+ | **pageSize** | `number` | Number of results to return per page. | [Optional] [Defaults to `undefined`] |
1301
+ | **search** | `string` | A search term. | [Optional] [Defaults to `undefined`] |
1302
+
1303
+ ### Return type
1304
+
1305
+ [**PaginatedServiceConnectionList**](PaginatedServiceConnectionList.md)
1306
+
1307
+ ### Authorization
1308
+
1309
+ [authentik](../README.md#authentik)
1310
+
1311
+ ### HTTP request headers
1312
+
1313
+ - **Content-Type**: Not defined
1314
+ - **Accept**: `application/json`
1315
+
1316
+
1317
+ ### HTTP response details
1318
+ | Status code | Description | Response headers |
1319
+ |-------------|-------------|------------------|
1320
+ | **200** | | - |
1321
+ | **400** | | - |
1322
+ | **403** | | - |
1323
+
1324
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1325
+
1326
+
1327
+ ## outpostsServiceConnectionsAllRetrieve
1328
+
1329
+ > ServiceConnection outpostsServiceConnectionsAllRetrieve(uuid)
1330
+
1331
+
1332
+
1333
+ ServiceConnection Viewset
1334
+
1335
+ ### Example
1336
+
1337
+ ```ts
1338
+ import {
1339
+ Configuration,
1340
+ OutpostsApi,
1341
+ } from '@goauthentik/api';
1342
+ import type { OutpostsServiceConnectionsAllRetrieveRequest } from '@goauthentik/api';
1343
+
1344
+ async function example() {
1345
+ console.log("🚀 Testing @goauthentik/api SDK...");
1346
+ const config = new Configuration({
1347
+ // Configure HTTP bearer authorization: authentik
1348
+ accessToken: "YOUR BEARER TOKEN",
1349
+ });
1350
+ const api = new OutpostsApi(config);
1351
+
1352
+ const body = {
1353
+ // string | A UUID string identifying this Outpost Service-Connection.
1354
+ uuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1355
+ } satisfies OutpostsServiceConnectionsAllRetrieveRequest;
1356
+
1357
+ try {
1358
+ const data = await api.outpostsServiceConnectionsAllRetrieve(body);
1359
+ console.log(data);
1360
+ } catch (error) {
1361
+ console.error(error);
1362
+ }
1363
+ }
1364
+
1365
+ // Run the test
1366
+ example().catch(console.error);
1367
+ ```
1368
+
1369
+ ### Parameters
1370
+
1371
+
1372
+ | Name | Type | Description | Notes |
1373
+ |------------- | ------------- | ------------- | -------------|
1374
+ | **uuid** | `string` | A UUID string identifying this Outpost Service-Connection. | [Defaults to `undefined`] |
1375
+
1376
+ ### Return type
1377
+
1378
+ [**ServiceConnection**](ServiceConnection.md)
1379
+
1380
+ ### Authorization
1381
+
1382
+ [authentik](../README.md#authentik)
1383
+
1384
+ ### HTTP request headers
1385
+
1386
+ - **Content-Type**: Not defined
1387
+ - **Accept**: `application/json`
1388
+
1389
+
1390
+ ### HTTP response details
1391
+ | Status code | Description | Response headers |
1392
+ |-------------|-------------|------------------|
1393
+ | **200** | | - |
1394
+ | **400** | | - |
1395
+ | **403** | | - |
1396
+
1397
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1398
+
1399
+
1400
+ ## outpostsServiceConnectionsAllStateRetrieve
1401
+
1402
+ > ServiceConnectionState outpostsServiceConnectionsAllStateRetrieve(uuid)
1403
+
1404
+
1405
+
1406
+ Get the service connection\&#39;s state
1407
+
1408
+ ### Example
1409
+
1410
+ ```ts
1411
+ import {
1412
+ Configuration,
1413
+ OutpostsApi,
1414
+ } from '@goauthentik/api';
1415
+ import type { OutpostsServiceConnectionsAllStateRetrieveRequest } from '@goauthentik/api';
1416
+
1417
+ async function example() {
1418
+ console.log("🚀 Testing @goauthentik/api SDK...");
1419
+ const config = new Configuration({
1420
+ // Configure HTTP bearer authorization: authentik
1421
+ accessToken: "YOUR BEARER TOKEN",
1422
+ });
1423
+ const api = new OutpostsApi(config);
1424
+
1425
+ const body = {
1426
+ // string | A UUID string identifying this Outpost Service-Connection.
1427
+ uuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1428
+ } satisfies OutpostsServiceConnectionsAllStateRetrieveRequest;
1429
+
1430
+ try {
1431
+ const data = await api.outpostsServiceConnectionsAllStateRetrieve(body);
1432
+ console.log(data);
1433
+ } catch (error) {
1434
+ console.error(error);
1435
+ }
1436
+ }
1437
+
1438
+ // Run the test
1439
+ example().catch(console.error);
1440
+ ```
1441
+
1442
+ ### Parameters
1443
+
1444
+
1445
+ | Name | Type | Description | Notes |
1446
+ |------------- | ------------- | ------------- | -------------|
1447
+ | **uuid** | `string` | A UUID string identifying this Outpost Service-Connection. | [Defaults to `undefined`] |
1448
+
1449
+ ### Return type
1450
+
1451
+ [**ServiceConnectionState**](ServiceConnectionState.md)
1452
+
1453
+ ### Authorization
1454
+
1455
+ [authentik](../README.md#authentik)
1456
+
1457
+ ### HTTP request headers
1458
+
1459
+ - **Content-Type**: Not defined
1460
+ - **Accept**: `application/json`
1461
+
1462
+
1463
+ ### HTTP response details
1464
+ | Status code | Description | Response headers |
1465
+ |-------------|-------------|------------------|
1466
+ | **200** | | - |
1467
+ | **400** | | - |
1468
+ | **403** | | - |
1469
+
1470
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1471
+
1472
+
1473
+ ## outpostsServiceConnectionsAllTypesList
1474
+
1475
+ > Array&lt;TypeCreate&gt; outpostsServiceConnectionsAllTypesList()
1476
+
1477
+
1478
+
1479
+ Get all creatable types
1480
+
1481
+ ### Example
1482
+
1483
+ ```ts
1484
+ import {
1485
+ Configuration,
1486
+ OutpostsApi,
1487
+ } from '@goauthentik/api';
1488
+ import type { OutpostsServiceConnectionsAllTypesListRequest } from '@goauthentik/api';
1489
+
1490
+ async function example() {
1491
+ console.log("🚀 Testing @goauthentik/api SDK...");
1492
+ const config = new Configuration({
1493
+ // Configure HTTP bearer authorization: authentik
1494
+ accessToken: "YOUR BEARER TOKEN",
1495
+ });
1496
+ const api = new OutpostsApi(config);
1497
+
1498
+ try {
1499
+ const data = await api.outpostsServiceConnectionsAllTypesList();
1500
+ console.log(data);
1501
+ } catch (error) {
1502
+ console.error(error);
1503
+ }
1504
+ }
1505
+
1506
+ // Run the test
1507
+ example().catch(console.error);
1508
+ ```
1509
+
1510
+ ### Parameters
1511
+
1512
+ This endpoint does not need any parameter.
1513
+
1514
+ ### Return type
1515
+
1516
+ [**Array&lt;TypeCreate&gt;**](TypeCreate.md)
1517
+
1518
+ ### Authorization
1519
+
1520
+ [authentik](../README.md#authentik)
1521
+
1522
+ ### HTTP request headers
1523
+
1524
+ - **Content-Type**: Not defined
1525
+ - **Accept**: `application/json`
1526
+
1527
+
1528
+ ### HTTP response details
1529
+ | Status code | Description | Response headers |
1530
+ |-------------|-------------|------------------|
1531
+ | **200** | | - |
1532
+ | **400** | | - |
1533
+ | **403** | | - |
1534
+
1535
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1536
+
1537
+
1538
+ ## outpostsServiceConnectionsAllUsedByList
1539
+
1540
+ > Array&lt;UsedBy&gt; outpostsServiceConnectionsAllUsedByList(uuid)
1541
+
1542
+
1543
+
1544
+ Get a list of all objects that use this object
1545
+
1546
+ ### Example
1547
+
1548
+ ```ts
1549
+ import {
1550
+ Configuration,
1551
+ OutpostsApi,
1552
+ } from '@goauthentik/api';
1553
+ import type { OutpostsServiceConnectionsAllUsedByListRequest } from '@goauthentik/api';
1554
+
1555
+ async function example() {
1556
+ console.log("🚀 Testing @goauthentik/api SDK...");
1557
+ const config = new Configuration({
1558
+ // Configure HTTP bearer authorization: authentik
1559
+ accessToken: "YOUR BEARER TOKEN",
1560
+ });
1561
+ const api = new OutpostsApi(config);
1562
+
1563
+ const body = {
1564
+ // string | A UUID string identifying this Outpost Service-Connection.
1565
+ uuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1566
+ } satisfies OutpostsServiceConnectionsAllUsedByListRequest;
1567
+
1568
+ try {
1569
+ const data = await api.outpostsServiceConnectionsAllUsedByList(body);
1570
+ console.log(data);
1571
+ } catch (error) {
1572
+ console.error(error);
1573
+ }
1574
+ }
1575
+
1576
+ // Run the test
1577
+ example().catch(console.error);
1578
+ ```
1579
+
1580
+ ### Parameters
1581
+
1582
+
1583
+ | Name | Type | Description | Notes |
1584
+ |------------- | ------------- | ------------- | -------------|
1585
+ | **uuid** | `string` | A UUID string identifying this Outpost Service-Connection. | [Defaults to `undefined`] |
1586
+
1587
+ ### Return type
1588
+
1589
+ [**Array&lt;UsedBy&gt;**](UsedBy.md)
1590
+
1591
+ ### Authorization
1592
+
1593
+ [authentik](../README.md#authentik)
1594
+
1595
+ ### HTTP request headers
1596
+
1597
+ - **Content-Type**: Not defined
1598
+ - **Accept**: `application/json`
1599
+
1600
+
1601
+ ### HTTP response details
1602
+ | Status code | Description | Response headers |
1603
+ |-------------|-------------|------------------|
1604
+ | **200** | | - |
1605
+ | **400** | | - |
1606
+ | **403** | | - |
1607
+
1608
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1609
+
1610
+
1611
+ ## outpostsServiceConnectionsDockerCreate
1612
+
1613
+ > DockerServiceConnection outpostsServiceConnectionsDockerCreate(dockerServiceConnectionRequest)
1614
+
1615
+
1616
+
1617
+ DockerServiceConnection Viewset
1618
+
1619
+ ### Example
1620
+
1621
+ ```ts
1622
+ import {
1623
+ Configuration,
1624
+ OutpostsApi,
1625
+ } from '@goauthentik/api';
1626
+ import type { OutpostsServiceConnectionsDockerCreateRequest } from '@goauthentik/api';
1627
+
1628
+ async function example() {
1629
+ console.log("🚀 Testing @goauthentik/api SDK...");
1630
+ const config = new Configuration({
1631
+ // Configure HTTP bearer authorization: authentik
1632
+ accessToken: "YOUR BEARER TOKEN",
1633
+ });
1634
+ const api = new OutpostsApi(config);
1635
+
1636
+ const body = {
1637
+ // DockerServiceConnectionRequest
1638
+ dockerServiceConnectionRequest: ...,
1639
+ } satisfies OutpostsServiceConnectionsDockerCreateRequest;
1640
+
1641
+ try {
1642
+ const data = await api.outpostsServiceConnectionsDockerCreate(body);
1643
+ console.log(data);
1644
+ } catch (error) {
1645
+ console.error(error);
1646
+ }
1647
+ }
1648
+
1649
+ // Run the test
1650
+ example().catch(console.error);
1651
+ ```
1652
+
1653
+ ### Parameters
1654
+
1655
+
1656
+ | Name | Type | Description | Notes |
1657
+ |------------- | ------------- | ------------- | -------------|
1658
+ | **dockerServiceConnectionRequest** | [DockerServiceConnectionRequest](DockerServiceConnectionRequest.md) | | |
1659
+
1660
+ ### Return type
1661
+
1662
+ [**DockerServiceConnection**](DockerServiceConnection.md)
1663
+
1664
+ ### Authorization
1665
+
1666
+ [authentik](../README.md#authentik)
1667
+
1668
+ ### HTTP request headers
1669
+
1670
+ - **Content-Type**: `application/json`
1671
+ - **Accept**: `application/json`
1672
+
1673
+
1674
+ ### HTTP response details
1675
+ | Status code | Description | Response headers |
1676
+ |-------------|-------------|------------------|
1677
+ | **201** | | - |
1678
+ | **400** | | - |
1679
+ | **403** | | - |
1680
+
1681
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1682
+
1683
+
1684
+ ## outpostsServiceConnectionsDockerDestroy
1685
+
1686
+ > outpostsServiceConnectionsDockerDestroy(uuid)
1687
+
1688
+
1689
+
1690
+ DockerServiceConnection Viewset
1691
+
1692
+ ### Example
1693
+
1694
+ ```ts
1695
+ import {
1696
+ Configuration,
1697
+ OutpostsApi,
1698
+ } from '@goauthentik/api';
1699
+ import type { OutpostsServiceConnectionsDockerDestroyRequest } from '@goauthentik/api';
1700
+
1701
+ async function example() {
1702
+ console.log("🚀 Testing @goauthentik/api SDK...");
1703
+ const config = new Configuration({
1704
+ // Configure HTTP bearer authorization: authentik
1705
+ accessToken: "YOUR BEARER TOKEN",
1706
+ });
1707
+ const api = new OutpostsApi(config);
1708
+
1709
+ const body = {
1710
+ // string | A UUID string identifying this Docker Service-Connection.
1711
+ uuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1712
+ } satisfies OutpostsServiceConnectionsDockerDestroyRequest;
1713
+
1714
+ try {
1715
+ const data = await api.outpostsServiceConnectionsDockerDestroy(body);
1716
+ console.log(data);
1717
+ } catch (error) {
1718
+ console.error(error);
1719
+ }
1720
+ }
1721
+
1722
+ // Run the test
1723
+ example().catch(console.error);
1724
+ ```
1725
+
1726
+ ### Parameters
1727
+
1728
+
1729
+ | Name | Type | Description | Notes |
1730
+ |------------- | ------------- | ------------- | -------------|
1731
+ | **uuid** | `string` | A UUID string identifying this Docker Service-Connection. | [Defaults to `undefined`] |
1732
+
1733
+ ### Return type
1734
+
1735
+ `void` (Empty response body)
1736
+
1737
+ ### Authorization
1738
+
1739
+ [authentik](../README.md#authentik)
1740
+
1741
+ ### HTTP request headers
1742
+
1743
+ - **Content-Type**: Not defined
1744
+ - **Accept**: `application/json`
1745
+
1746
+
1747
+ ### HTTP response details
1748
+ | Status code | Description | Response headers |
1749
+ |-------------|-------------|------------------|
1750
+ | **204** | No response body | - |
1751
+ | **400** | | - |
1752
+ | **403** | | - |
1753
+
1754
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1755
+
1756
+
1757
+ ## outpostsServiceConnectionsDockerList
1758
+
1759
+ > PaginatedDockerServiceConnectionList outpostsServiceConnectionsDockerList(local, name, ordering, page, pageSize, search, tlsAuthentication, tlsVerification, url)
1760
+
1761
+
1762
+
1763
+ DockerServiceConnection Viewset
1764
+
1765
+ ### Example
1766
+
1767
+ ```ts
1768
+ import {
1769
+ Configuration,
1770
+ OutpostsApi,
1771
+ } from '@goauthentik/api';
1772
+ import type { OutpostsServiceConnectionsDockerListRequest } from '@goauthentik/api';
1773
+
1774
+ async function example() {
1775
+ console.log("🚀 Testing @goauthentik/api SDK...");
1776
+ const config = new Configuration({
1777
+ // Configure HTTP bearer authorization: authentik
1778
+ accessToken: "YOUR BEARER TOKEN",
1779
+ });
1780
+ const api = new OutpostsApi(config);
1781
+
1782
+ const body = {
1783
+ // boolean (optional)
1784
+ local: true,
1785
+ // string (optional)
1786
+ name: name_example,
1787
+ // string | Which field to use when ordering the results. (optional)
1788
+ ordering: ordering_example,
1789
+ // number | A page number within the paginated result set. (optional)
1790
+ page: 56,
1791
+ // number | Number of results to return per page. (optional)
1792
+ pageSize: 56,
1793
+ // string | A search term. (optional)
1794
+ search: search_example,
1795
+ // string (optional)
1796
+ tlsAuthentication: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1797
+ // string (optional)
1798
+ tlsVerification: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1799
+ // string (optional)
1800
+ url: url_example,
1801
+ } satisfies OutpostsServiceConnectionsDockerListRequest;
1802
+
1803
+ try {
1804
+ const data = await api.outpostsServiceConnectionsDockerList(body);
1805
+ console.log(data);
1806
+ } catch (error) {
1807
+ console.error(error);
1808
+ }
1809
+ }
1810
+
1811
+ // Run the test
1812
+ example().catch(console.error);
1813
+ ```
1814
+
1815
+ ### Parameters
1816
+
1817
+
1818
+ | Name | Type | Description | Notes |
1819
+ |------------- | ------------- | ------------- | -------------|
1820
+ | **local** | `boolean` | | [Optional] [Defaults to `undefined`] |
1821
+ | **name** | `string` | | [Optional] [Defaults to `undefined`] |
1822
+ | **ordering** | `string` | Which field to use when ordering the results. | [Optional] [Defaults to `undefined`] |
1823
+ | **page** | `number` | A page number within the paginated result set. | [Optional] [Defaults to `undefined`] |
1824
+ | **pageSize** | `number` | Number of results to return per page. | [Optional] [Defaults to `undefined`] |
1825
+ | **search** | `string` | A search term. | [Optional] [Defaults to `undefined`] |
1826
+ | **tlsAuthentication** | `string` | | [Optional] [Defaults to `undefined`] |
1827
+ | **tlsVerification** | `string` | | [Optional] [Defaults to `undefined`] |
1828
+ | **url** | `string` | | [Optional] [Defaults to `undefined`] |
1829
+
1830
+ ### Return type
1831
+
1832
+ [**PaginatedDockerServiceConnectionList**](PaginatedDockerServiceConnectionList.md)
1833
+
1834
+ ### Authorization
1835
+
1836
+ [authentik](../README.md#authentik)
1837
+
1838
+ ### HTTP request headers
1839
+
1840
+ - **Content-Type**: Not defined
1841
+ - **Accept**: `application/json`
1842
+
1843
+
1844
+ ### HTTP response details
1845
+ | Status code | Description | Response headers |
1846
+ |-------------|-------------|------------------|
1847
+ | **200** | | - |
1848
+ | **400** | | - |
1849
+ | **403** | | - |
1850
+
1851
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1852
+
1853
+
1854
+ ## outpostsServiceConnectionsDockerPartialUpdate
1855
+
1856
+ > DockerServiceConnection outpostsServiceConnectionsDockerPartialUpdate(uuid, patchedDockerServiceConnectionRequest)
1857
+
1858
+
1859
+
1860
+ DockerServiceConnection Viewset
1861
+
1862
+ ### Example
1863
+
1864
+ ```ts
1865
+ import {
1866
+ Configuration,
1867
+ OutpostsApi,
1868
+ } from '@goauthentik/api';
1869
+ import type { OutpostsServiceConnectionsDockerPartialUpdateRequest } from '@goauthentik/api';
1870
+
1871
+ async function example() {
1872
+ console.log("🚀 Testing @goauthentik/api SDK...");
1873
+ const config = new Configuration({
1874
+ // Configure HTTP bearer authorization: authentik
1875
+ accessToken: "YOUR BEARER TOKEN",
1876
+ });
1877
+ const api = new OutpostsApi(config);
1878
+
1879
+ const body = {
1880
+ // string | A UUID string identifying this Docker Service-Connection.
1881
+ uuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1882
+ // PatchedDockerServiceConnectionRequest (optional)
1883
+ patchedDockerServiceConnectionRequest: ...,
1884
+ } satisfies OutpostsServiceConnectionsDockerPartialUpdateRequest;
1885
+
1886
+ try {
1887
+ const data = await api.outpostsServiceConnectionsDockerPartialUpdate(body);
1888
+ console.log(data);
1889
+ } catch (error) {
1890
+ console.error(error);
1891
+ }
1892
+ }
1893
+
1894
+ // Run the test
1895
+ example().catch(console.error);
1896
+ ```
1897
+
1898
+ ### Parameters
1899
+
1900
+
1901
+ | Name | Type | Description | Notes |
1902
+ |------------- | ------------- | ------------- | -------------|
1903
+ | **uuid** | `string` | A UUID string identifying this Docker Service-Connection. | [Defaults to `undefined`] |
1904
+ | **patchedDockerServiceConnectionRequest** | [PatchedDockerServiceConnectionRequest](PatchedDockerServiceConnectionRequest.md) | | [Optional] |
1905
+
1906
+ ### Return type
1907
+
1908
+ [**DockerServiceConnection**](DockerServiceConnection.md)
1909
+
1910
+ ### Authorization
1911
+
1912
+ [authentik](../README.md#authentik)
1913
+
1914
+ ### HTTP request headers
1915
+
1916
+ - **Content-Type**: `application/json`
1917
+ - **Accept**: `application/json`
1918
+
1919
+
1920
+ ### HTTP response details
1921
+ | Status code | Description | Response headers |
1922
+ |-------------|-------------|------------------|
1923
+ | **200** | | - |
1924
+ | **400** | | - |
1925
+ | **403** | | - |
1926
+
1927
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1928
+
1929
+
1930
+ ## outpostsServiceConnectionsDockerRetrieve
1931
+
1932
+ > DockerServiceConnection outpostsServiceConnectionsDockerRetrieve(uuid)
1933
+
1934
+
1935
+
1936
+ DockerServiceConnection Viewset
1937
+
1938
+ ### Example
1939
+
1940
+ ```ts
1941
+ import {
1942
+ Configuration,
1943
+ OutpostsApi,
1944
+ } from '@goauthentik/api';
1945
+ import type { OutpostsServiceConnectionsDockerRetrieveRequest } from '@goauthentik/api';
1946
+
1947
+ async function example() {
1948
+ console.log("🚀 Testing @goauthentik/api SDK...");
1949
+ const config = new Configuration({
1950
+ // Configure HTTP bearer authorization: authentik
1951
+ accessToken: "YOUR BEARER TOKEN",
1952
+ });
1953
+ const api = new OutpostsApi(config);
1954
+
1955
+ const body = {
1956
+ // string | A UUID string identifying this Docker Service-Connection.
1957
+ uuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1958
+ } satisfies OutpostsServiceConnectionsDockerRetrieveRequest;
1959
+
1960
+ try {
1961
+ const data = await api.outpostsServiceConnectionsDockerRetrieve(body);
1962
+ console.log(data);
1963
+ } catch (error) {
1964
+ console.error(error);
1965
+ }
1966
+ }
1967
+
1968
+ // Run the test
1969
+ example().catch(console.error);
1970
+ ```
1971
+
1972
+ ### Parameters
1973
+
1974
+
1975
+ | Name | Type | Description | Notes |
1976
+ |------------- | ------------- | ------------- | -------------|
1977
+ | **uuid** | `string` | A UUID string identifying this Docker Service-Connection. | [Defaults to `undefined`] |
1978
+
1979
+ ### Return type
1980
+
1981
+ [**DockerServiceConnection**](DockerServiceConnection.md)
1982
+
1983
+ ### Authorization
1984
+
1985
+ [authentik](../README.md#authentik)
1986
+
1987
+ ### HTTP request headers
1988
+
1989
+ - **Content-Type**: Not defined
1990
+ - **Accept**: `application/json`
1991
+
1992
+
1993
+ ### HTTP response details
1994
+ | Status code | Description | Response headers |
1995
+ |-------------|-------------|------------------|
1996
+ | **200** | | - |
1997
+ | **400** | | - |
1998
+ | **403** | | - |
1999
+
2000
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2001
+
2002
+
2003
+ ## outpostsServiceConnectionsDockerUpdate
2004
+
2005
+ > DockerServiceConnection outpostsServiceConnectionsDockerUpdate(uuid, dockerServiceConnectionRequest)
2006
+
2007
+
2008
+
2009
+ DockerServiceConnection Viewset
2010
+
2011
+ ### Example
2012
+
2013
+ ```ts
2014
+ import {
2015
+ Configuration,
2016
+ OutpostsApi,
2017
+ } from '@goauthentik/api';
2018
+ import type { OutpostsServiceConnectionsDockerUpdateRequest } from '@goauthentik/api';
2019
+
2020
+ async function example() {
2021
+ console.log("🚀 Testing @goauthentik/api SDK...");
2022
+ const config = new Configuration({
2023
+ // Configure HTTP bearer authorization: authentik
2024
+ accessToken: "YOUR BEARER TOKEN",
2025
+ });
2026
+ const api = new OutpostsApi(config);
2027
+
2028
+ const body = {
2029
+ // string | A UUID string identifying this Docker Service-Connection.
2030
+ uuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
2031
+ // DockerServiceConnectionRequest
2032
+ dockerServiceConnectionRequest: ...,
2033
+ } satisfies OutpostsServiceConnectionsDockerUpdateRequest;
2034
+
2035
+ try {
2036
+ const data = await api.outpostsServiceConnectionsDockerUpdate(body);
2037
+ console.log(data);
2038
+ } catch (error) {
2039
+ console.error(error);
2040
+ }
2041
+ }
2042
+
2043
+ // Run the test
2044
+ example().catch(console.error);
2045
+ ```
2046
+
2047
+ ### Parameters
2048
+
2049
+
2050
+ | Name | Type | Description | Notes |
2051
+ |------------- | ------------- | ------------- | -------------|
2052
+ | **uuid** | `string` | A UUID string identifying this Docker Service-Connection. | [Defaults to `undefined`] |
2053
+ | **dockerServiceConnectionRequest** | [DockerServiceConnectionRequest](DockerServiceConnectionRequest.md) | | |
2054
+
2055
+ ### Return type
2056
+
2057
+ [**DockerServiceConnection**](DockerServiceConnection.md)
2058
+
2059
+ ### Authorization
2060
+
2061
+ [authentik](../README.md#authentik)
2062
+
2063
+ ### HTTP request headers
2064
+
2065
+ - **Content-Type**: `application/json`
2066
+ - **Accept**: `application/json`
2067
+
2068
+
2069
+ ### HTTP response details
2070
+ | Status code | Description | Response headers |
2071
+ |-------------|-------------|------------------|
2072
+ | **200** | | - |
2073
+ | **400** | | - |
2074
+ | **403** | | - |
2075
+
2076
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2077
+
2078
+
2079
+ ## outpostsServiceConnectionsDockerUsedByList
2080
+
2081
+ > Array&lt;UsedBy&gt; outpostsServiceConnectionsDockerUsedByList(uuid)
2082
+
2083
+
2084
+
2085
+ Get a list of all objects that use this object
2086
+
2087
+ ### Example
2088
+
2089
+ ```ts
2090
+ import {
2091
+ Configuration,
2092
+ OutpostsApi,
2093
+ } from '@goauthentik/api';
2094
+ import type { OutpostsServiceConnectionsDockerUsedByListRequest } from '@goauthentik/api';
2095
+
2096
+ async function example() {
2097
+ console.log("🚀 Testing @goauthentik/api SDK...");
2098
+ const config = new Configuration({
2099
+ // Configure HTTP bearer authorization: authentik
2100
+ accessToken: "YOUR BEARER TOKEN",
2101
+ });
2102
+ const api = new OutpostsApi(config);
2103
+
2104
+ const body = {
2105
+ // string | A UUID string identifying this Docker Service-Connection.
2106
+ uuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
2107
+ } satisfies OutpostsServiceConnectionsDockerUsedByListRequest;
2108
+
2109
+ try {
2110
+ const data = await api.outpostsServiceConnectionsDockerUsedByList(body);
2111
+ console.log(data);
2112
+ } catch (error) {
2113
+ console.error(error);
2114
+ }
2115
+ }
2116
+
2117
+ // Run the test
2118
+ example().catch(console.error);
2119
+ ```
2120
+
2121
+ ### Parameters
2122
+
2123
+
2124
+ | Name | Type | Description | Notes |
2125
+ |------------- | ------------- | ------------- | -------------|
2126
+ | **uuid** | `string` | A UUID string identifying this Docker Service-Connection. | [Defaults to `undefined`] |
2127
+
2128
+ ### Return type
2129
+
2130
+ [**Array&lt;UsedBy&gt;**](UsedBy.md)
2131
+
2132
+ ### Authorization
2133
+
2134
+ [authentik](../README.md#authentik)
2135
+
2136
+ ### HTTP request headers
2137
+
2138
+ - **Content-Type**: Not defined
2139
+ - **Accept**: `application/json`
2140
+
2141
+
2142
+ ### HTTP response details
2143
+ | Status code | Description | Response headers |
2144
+ |-------------|-------------|------------------|
2145
+ | **200** | | - |
2146
+ | **400** | | - |
2147
+ | **403** | | - |
2148
+
2149
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2150
+
2151
+
2152
+ ## outpostsServiceConnectionsKubernetesCreate
2153
+
2154
+ > KubernetesServiceConnection outpostsServiceConnectionsKubernetesCreate(kubernetesServiceConnectionRequest)
2155
+
2156
+
2157
+
2158
+ KubernetesServiceConnection Viewset
2159
+
2160
+ ### Example
2161
+
2162
+ ```ts
2163
+ import {
2164
+ Configuration,
2165
+ OutpostsApi,
2166
+ } from '@goauthentik/api';
2167
+ import type { OutpostsServiceConnectionsKubernetesCreateRequest } from '@goauthentik/api';
2168
+
2169
+ async function example() {
2170
+ console.log("🚀 Testing @goauthentik/api SDK...");
2171
+ const config = new Configuration({
2172
+ // Configure HTTP bearer authorization: authentik
2173
+ accessToken: "YOUR BEARER TOKEN",
2174
+ });
2175
+ const api = new OutpostsApi(config);
2176
+
2177
+ const body = {
2178
+ // KubernetesServiceConnectionRequest
2179
+ kubernetesServiceConnectionRequest: ...,
2180
+ } satisfies OutpostsServiceConnectionsKubernetesCreateRequest;
2181
+
2182
+ try {
2183
+ const data = await api.outpostsServiceConnectionsKubernetesCreate(body);
2184
+ console.log(data);
2185
+ } catch (error) {
2186
+ console.error(error);
2187
+ }
2188
+ }
2189
+
2190
+ // Run the test
2191
+ example().catch(console.error);
2192
+ ```
2193
+
2194
+ ### Parameters
2195
+
2196
+
2197
+ | Name | Type | Description | Notes |
2198
+ |------------- | ------------- | ------------- | -------------|
2199
+ | **kubernetesServiceConnectionRequest** | [KubernetesServiceConnectionRequest](KubernetesServiceConnectionRequest.md) | | |
2200
+
2201
+ ### Return type
2202
+
2203
+ [**KubernetesServiceConnection**](KubernetesServiceConnection.md)
2204
+
2205
+ ### Authorization
2206
+
2207
+ [authentik](../README.md#authentik)
2208
+
2209
+ ### HTTP request headers
2210
+
2211
+ - **Content-Type**: `application/json`
2212
+ - **Accept**: `application/json`
2213
+
2214
+
2215
+ ### HTTP response details
2216
+ | Status code | Description | Response headers |
2217
+ |-------------|-------------|------------------|
2218
+ | **201** | | - |
2219
+ | **400** | | - |
2220
+ | **403** | | - |
2221
+
2222
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2223
+
2224
+
2225
+ ## outpostsServiceConnectionsKubernetesDestroy
2226
+
2227
+ > outpostsServiceConnectionsKubernetesDestroy(uuid)
2228
+
2229
+
2230
+
2231
+ KubernetesServiceConnection Viewset
2232
+
2233
+ ### Example
2234
+
2235
+ ```ts
2236
+ import {
2237
+ Configuration,
2238
+ OutpostsApi,
2239
+ } from '@goauthentik/api';
2240
+ import type { OutpostsServiceConnectionsKubernetesDestroyRequest } from '@goauthentik/api';
2241
+
2242
+ async function example() {
2243
+ console.log("🚀 Testing @goauthentik/api SDK...");
2244
+ const config = new Configuration({
2245
+ // Configure HTTP bearer authorization: authentik
2246
+ accessToken: "YOUR BEARER TOKEN",
2247
+ });
2248
+ const api = new OutpostsApi(config);
2249
+
2250
+ const body = {
2251
+ // string | A UUID string identifying this Kubernetes Service-Connection.
2252
+ uuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
2253
+ } satisfies OutpostsServiceConnectionsKubernetesDestroyRequest;
2254
+
2255
+ try {
2256
+ const data = await api.outpostsServiceConnectionsKubernetesDestroy(body);
2257
+ console.log(data);
2258
+ } catch (error) {
2259
+ console.error(error);
2260
+ }
2261
+ }
2262
+
2263
+ // Run the test
2264
+ example().catch(console.error);
2265
+ ```
2266
+
2267
+ ### Parameters
2268
+
2269
+
2270
+ | Name | Type | Description | Notes |
2271
+ |------------- | ------------- | ------------- | -------------|
2272
+ | **uuid** | `string` | A UUID string identifying this Kubernetes Service-Connection. | [Defaults to `undefined`] |
2273
+
2274
+ ### Return type
2275
+
2276
+ `void` (Empty response body)
2277
+
2278
+ ### Authorization
2279
+
2280
+ [authentik](../README.md#authentik)
2281
+
2282
+ ### HTTP request headers
2283
+
2284
+ - **Content-Type**: Not defined
2285
+ - **Accept**: `application/json`
2286
+
2287
+
2288
+ ### HTTP response details
2289
+ | Status code | Description | Response headers |
2290
+ |-------------|-------------|------------------|
2291
+ | **204** | No response body | - |
2292
+ | **400** | | - |
2293
+ | **403** | | - |
2294
+
2295
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2296
+
2297
+
2298
+ ## outpostsServiceConnectionsKubernetesList
2299
+
2300
+ > PaginatedKubernetesServiceConnectionList outpostsServiceConnectionsKubernetesList(local, name, ordering, page, pageSize, search)
2301
+
2302
+
2303
+
2304
+ KubernetesServiceConnection Viewset
2305
+
2306
+ ### Example
2307
+
2308
+ ```ts
2309
+ import {
2310
+ Configuration,
2311
+ OutpostsApi,
2312
+ } from '@goauthentik/api';
2313
+ import type { OutpostsServiceConnectionsKubernetesListRequest } from '@goauthentik/api';
2314
+
2315
+ async function example() {
2316
+ console.log("🚀 Testing @goauthentik/api SDK...");
2317
+ const config = new Configuration({
2318
+ // Configure HTTP bearer authorization: authentik
2319
+ accessToken: "YOUR BEARER TOKEN",
2320
+ });
2321
+ const api = new OutpostsApi(config);
2322
+
2323
+ const body = {
2324
+ // boolean (optional)
2325
+ local: true,
2326
+ // string (optional)
2327
+ name: name_example,
2328
+ // string | Which field to use when ordering the results. (optional)
2329
+ ordering: ordering_example,
2330
+ // number | A page number within the paginated result set. (optional)
2331
+ page: 56,
2332
+ // number | Number of results to return per page. (optional)
2333
+ pageSize: 56,
2334
+ // string | A search term. (optional)
2335
+ search: search_example,
2336
+ } satisfies OutpostsServiceConnectionsKubernetesListRequest;
2337
+
2338
+ try {
2339
+ const data = await api.outpostsServiceConnectionsKubernetesList(body);
2340
+ console.log(data);
2341
+ } catch (error) {
2342
+ console.error(error);
2343
+ }
2344
+ }
2345
+
2346
+ // Run the test
2347
+ example().catch(console.error);
2348
+ ```
2349
+
2350
+ ### Parameters
2351
+
2352
+
2353
+ | Name | Type | Description | Notes |
2354
+ |------------- | ------------- | ------------- | -------------|
2355
+ | **local** | `boolean` | | [Optional] [Defaults to `undefined`] |
2356
+ | **name** | `string` | | [Optional] [Defaults to `undefined`] |
2357
+ | **ordering** | `string` | Which field to use when ordering the results. | [Optional] [Defaults to `undefined`] |
2358
+ | **page** | `number` | A page number within the paginated result set. | [Optional] [Defaults to `undefined`] |
2359
+ | **pageSize** | `number` | Number of results to return per page. | [Optional] [Defaults to `undefined`] |
2360
+ | **search** | `string` | A search term. | [Optional] [Defaults to `undefined`] |
2361
+
2362
+ ### Return type
2363
+
2364
+ [**PaginatedKubernetesServiceConnectionList**](PaginatedKubernetesServiceConnectionList.md)
2365
+
2366
+ ### Authorization
2367
+
2368
+ [authentik](../README.md#authentik)
2369
+
2370
+ ### HTTP request headers
2371
+
2372
+ - **Content-Type**: Not defined
2373
+ - **Accept**: `application/json`
2374
+
2375
+
2376
+ ### HTTP response details
2377
+ | Status code | Description | Response headers |
2378
+ |-------------|-------------|------------------|
2379
+ | **200** | | - |
2380
+ | **400** | | - |
2381
+ | **403** | | - |
2382
+
2383
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2384
+
2385
+
2386
+ ## outpostsServiceConnectionsKubernetesPartialUpdate
2387
+
2388
+ > KubernetesServiceConnection outpostsServiceConnectionsKubernetesPartialUpdate(uuid, patchedKubernetesServiceConnectionRequest)
2389
+
2390
+
2391
+
2392
+ KubernetesServiceConnection Viewset
2393
+
2394
+ ### Example
2395
+
2396
+ ```ts
2397
+ import {
2398
+ Configuration,
2399
+ OutpostsApi,
2400
+ } from '@goauthentik/api';
2401
+ import type { OutpostsServiceConnectionsKubernetesPartialUpdateRequest } from '@goauthentik/api';
2402
+
2403
+ async function example() {
2404
+ console.log("🚀 Testing @goauthentik/api SDK...");
2405
+ const config = new Configuration({
2406
+ // Configure HTTP bearer authorization: authentik
2407
+ accessToken: "YOUR BEARER TOKEN",
2408
+ });
2409
+ const api = new OutpostsApi(config);
2410
+
2411
+ const body = {
2412
+ // string | A UUID string identifying this Kubernetes Service-Connection.
2413
+ uuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
2414
+ // PatchedKubernetesServiceConnectionRequest (optional)
2415
+ patchedKubernetesServiceConnectionRequest: ...,
2416
+ } satisfies OutpostsServiceConnectionsKubernetesPartialUpdateRequest;
2417
+
2418
+ try {
2419
+ const data = await api.outpostsServiceConnectionsKubernetesPartialUpdate(body);
2420
+ console.log(data);
2421
+ } catch (error) {
2422
+ console.error(error);
2423
+ }
2424
+ }
2425
+
2426
+ // Run the test
2427
+ example().catch(console.error);
2428
+ ```
2429
+
2430
+ ### Parameters
2431
+
2432
+
2433
+ | Name | Type | Description | Notes |
2434
+ |------------- | ------------- | ------------- | -------------|
2435
+ | **uuid** | `string` | A UUID string identifying this Kubernetes Service-Connection. | [Defaults to `undefined`] |
2436
+ | **patchedKubernetesServiceConnectionRequest** | [PatchedKubernetesServiceConnectionRequest](PatchedKubernetesServiceConnectionRequest.md) | | [Optional] |
2437
+
2438
+ ### Return type
2439
+
2440
+ [**KubernetesServiceConnection**](KubernetesServiceConnection.md)
2441
+
2442
+ ### Authorization
2443
+
2444
+ [authentik](../README.md#authentik)
2445
+
2446
+ ### HTTP request headers
2447
+
2448
+ - **Content-Type**: `application/json`
2449
+ - **Accept**: `application/json`
2450
+
2451
+
2452
+ ### HTTP response details
2453
+ | Status code | Description | Response headers |
2454
+ |-------------|-------------|------------------|
2455
+ | **200** | | - |
2456
+ | **400** | | - |
2457
+ | **403** | | - |
2458
+
2459
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2460
+
2461
+
2462
+ ## outpostsServiceConnectionsKubernetesRetrieve
2463
+
2464
+ > KubernetesServiceConnection outpostsServiceConnectionsKubernetesRetrieve(uuid)
2465
+
2466
+
2467
+
2468
+ KubernetesServiceConnection Viewset
2469
+
2470
+ ### Example
2471
+
2472
+ ```ts
2473
+ import {
2474
+ Configuration,
2475
+ OutpostsApi,
2476
+ } from '@goauthentik/api';
2477
+ import type { OutpostsServiceConnectionsKubernetesRetrieveRequest } from '@goauthentik/api';
2478
+
2479
+ async function example() {
2480
+ console.log("🚀 Testing @goauthentik/api SDK...");
2481
+ const config = new Configuration({
2482
+ // Configure HTTP bearer authorization: authentik
2483
+ accessToken: "YOUR BEARER TOKEN",
2484
+ });
2485
+ const api = new OutpostsApi(config);
2486
+
2487
+ const body = {
2488
+ // string | A UUID string identifying this Kubernetes Service-Connection.
2489
+ uuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
2490
+ } satisfies OutpostsServiceConnectionsKubernetesRetrieveRequest;
2491
+
2492
+ try {
2493
+ const data = await api.outpostsServiceConnectionsKubernetesRetrieve(body);
2494
+ console.log(data);
2495
+ } catch (error) {
2496
+ console.error(error);
2497
+ }
2498
+ }
2499
+
2500
+ // Run the test
2501
+ example().catch(console.error);
2502
+ ```
2503
+
2504
+ ### Parameters
2505
+
2506
+
2507
+ | Name | Type | Description | Notes |
2508
+ |------------- | ------------- | ------------- | -------------|
2509
+ | **uuid** | `string` | A UUID string identifying this Kubernetes Service-Connection. | [Defaults to `undefined`] |
2510
+
2511
+ ### Return type
2512
+
2513
+ [**KubernetesServiceConnection**](KubernetesServiceConnection.md)
2514
+
2515
+ ### Authorization
2516
+
2517
+ [authentik](../README.md#authentik)
2518
+
2519
+ ### HTTP request headers
2520
+
2521
+ - **Content-Type**: Not defined
2522
+ - **Accept**: `application/json`
2523
+
2524
+
2525
+ ### HTTP response details
2526
+ | Status code | Description | Response headers |
2527
+ |-------------|-------------|------------------|
2528
+ | **200** | | - |
2529
+ | **400** | | - |
2530
+ | **403** | | - |
2531
+
2532
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2533
+
2534
+
2535
+ ## outpostsServiceConnectionsKubernetesUpdate
2536
+
2537
+ > KubernetesServiceConnection outpostsServiceConnectionsKubernetesUpdate(uuid, kubernetesServiceConnectionRequest)
2538
+
2539
+
2540
+
2541
+ KubernetesServiceConnection Viewset
2542
+
2543
+ ### Example
2544
+
2545
+ ```ts
2546
+ import {
2547
+ Configuration,
2548
+ OutpostsApi,
2549
+ } from '@goauthentik/api';
2550
+ import type { OutpostsServiceConnectionsKubernetesUpdateRequest } from '@goauthentik/api';
2551
+
2552
+ async function example() {
2553
+ console.log("🚀 Testing @goauthentik/api SDK...");
2554
+ const config = new Configuration({
2555
+ // Configure HTTP bearer authorization: authentik
2556
+ accessToken: "YOUR BEARER TOKEN",
2557
+ });
2558
+ const api = new OutpostsApi(config);
2559
+
2560
+ const body = {
2561
+ // string | A UUID string identifying this Kubernetes Service-Connection.
2562
+ uuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
2563
+ // KubernetesServiceConnectionRequest
2564
+ kubernetesServiceConnectionRequest: ...,
2565
+ } satisfies OutpostsServiceConnectionsKubernetesUpdateRequest;
2566
+
2567
+ try {
2568
+ const data = await api.outpostsServiceConnectionsKubernetesUpdate(body);
2569
+ console.log(data);
2570
+ } catch (error) {
2571
+ console.error(error);
2572
+ }
2573
+ }
2574
+
2575
+ // Run the test
2576
+ example().catch(console.error);
2577
+ ```
2578
+
2579
+ ### Parameters
2580
+
2581
+
2582
+ | Name | Type | Description | Notes |
2583
+ |------------- | ------------- | ------------- | -------------|
2584
+ | **uuid** | `string` | A UUID string identifying this Kubernetes Service-Connection. | [Defaults to `undefined`] |
2585
+ | **kubernetesServiceConnectionRequest** | [KubernetesServiceConnectionRequest](KubernetesServiceConnectionRequest.md) | | |
2586
+
2587
+ ### Return type
2588
+
2589
+ [**KubernetesServiceConnection**](KubernetesServiceConnection.md)
2590
+
2591
+ ### Authorization
2592
+
2593
+ [authentik](../README.md#authentik)
2594
+
2595
+ ### HTTP request headers
2596
+
2597
+ - **Content-Type**: `application/json`
2598
+ - **Accept**: `application/json`
2599
+
2600
+
2601
+ ### HTTP response details
2602
+ | Status code | Description | Response headers |
2603
+ |-------------|-------------|------------------|
2604
+ | **200** | | - |
2605
+ | **400** | | - |
2606
+ | **403** | | - |
2607
+
2608
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2609
+
2610
+
2611
+ ## outpostsServiceConnectionsKubernetesUsedByList
2612
+
2613
+ > Array&lt;UsedBy&gt; outpostsServiceConnectionsKubernetesUsedByList(uuid)
2614
+
2615
+
2616
+
2617
+ Get a list of all objects that use this object
2618
+
2619
+ ### Example
2620
+
2621
+ ```ts
2622
+ import {
2623
+ Configuration,
2624
+ OutpostsApi,
2625
+ } from '@goauthentik/api';
2626
+ import type { OutpostsServiceConnectionsKubernetesUsedByListRequest } from '@goauthentik/api';
2627
+
2628
+ async function example() {
2629
+ console.log("🚀 Testing @goauthentik/api SDK...");
2630
+ const config = new Configuration({
2631
+ // Configure HTTP bearer authorization: authentik
2632
+ accessToken: "YOUR BEARER TOKEN",
2633
+ });
2634
+ const api = new OutpostsApi(config);
2635
+
2636
+ const body = {
2637
+ // string | A UUID string identifying this Kubernetes Service-Connection.
2638
+ uuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
2639
+ } satisfies OutpostsServiceConnectionsKubernetesUsedByListRequest;
2640
+
2641
+ try {
2642
+ const data = await api.outpostsServiceConnectionsKubernetesUsedByList(body);
2643
+ console.log(data);
2644
+ } catch (error) {
2645
+ console.error(error);
2646
+ }
2647
+ }
2648
+
2649
+ // Run the test
2650
+ example().catch(console.error);
2651
+ ```
2652
+
2653
+ ### Parameters
2654
+
2655
+
2656
+ | Name | Type | Description | Notes |
2657
+ |------------- | ------------- | ------------- | -------------|
2658
+ | **uuid** | `string` | A UUID string identifying this Kubernetes Service-Connection. | [Defaults to `undefined`] |
2659
+
2660
+ ### Return type
2661
+
2662
+ [**Array&lt;UsedBy&gt;**](UsedBy.md)
2663
+
2664
+ ### Authorization
2665
+
2666
+ [authentik](../README.md#authentik)
2667
+
2668
+ ### HTTP request headers
2669
+
2670
+ - **Content-Type**: Not defined
2671
+ - **Accept**: `application/json`
2672
+
2673
+
2674
+ ### HTTP response details
2675
+ | Status code | Description | Response headers |
2676
+ |-------------|-------------|------------------|
2677
+ | **200** | | - |
2678
+ | **400** | | - |
2679
+ | **403** | | - |
2680
+
2681
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2682
+