@goauthentik/api 2026.2.0-rc1-1766432129 → 2026.2.0-rc1-1767654897

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