authentik-api 2025.12.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d869f7bc78766614a4e784d608e0896914c3c025ae96e0c9130890370675184e
+  data.tar.gz: 559358bc18fbcbdc576bfba4e14cf37a52987c05bd528e39198bdc7289a9995f
+SHA512:
+  metadata.gz: f3d8e8d9405d05c71d17f590c3f79ad54650363cd4b67d8a2c2d460c4d8e5181c8d648ddce6cc557a7f392af0493f6c028f59138672f33c8199feb138bb95da6
+  data.tar.gz: 2fe55522ad3cef37f7bb5db26c2da80f19a6250f02a404619e57236c9589e599b40c646db947d349b090b5fa674a8686d4e4d6e34c7b938e35b0f2a8cee3110d

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+This project follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.
+
+If you have any concerns about behaviour within this project, please contact us at ["david.uhlig@gmail.com"](mailto:"david.uhlig@gmail.com").

data/LICENSE.md

@@ -0,0 +1,27 @@
+# License
+
+Portions of this software are licensed as follows:
+* The authentik [OpenAPI schema document](./.authentik/schema.yaml) is licensed under the ["MIT" license](https://github.com/goauthentik/authentik/blob/17594f17f426356cf8bf4d50b992bad20e4d9b7c/LICENSE).
+* Content outside the above-mentioned files is available under the "MIT" license as defined below. 
+
+## The MIT License (MIT)
+
+Copyright (c) 2026 David Uhlig
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,90 @@
+# 🔓 authentik API Client
+
+[![Gem Version](http://img.shields.io/gem/v/authentik-api.svg)][gem]
+[![License: MIT](https://img.shields.io/github/license/david-uhlig/authentik-api?label=License&labelColor=343B42&color=blue)][license]
+[![Tests](https://github.com/david-uhlig/authentik-api/actions/workflows/main.yml/badge.svg)][tests]
+
+##  Baseline client generated directly from OpenAPI definitions
+
+A Ruby client for the [authentik] API; an open-source Identity Provider (IdP) and Single Sign On (SSO) platform, auto-generated using the [OpenAPI Generator].
+
+The client allows you to create, update, and delete configuration objects in authentik (for example, users and groups). It is not intended for implementing SSO within your application.
+
+This project uses [Zeitwerk] for autoloading, so only API and model classes you use are loaded on demand; no `require` calls are needed.
+
+> [!IMPORTANT]
+> For most applications, use the [authentik-client] gem instead. It provides an idiomatic Ruby interface and an improved developer experience.
+
+## Installation
+
+Add this line to your application's Gemfile to receive the version that tracks the latest authentik release:
+
+```ruby
+gem "authentik-api"
+```
+
+Then execute `bundle install`. Alternatively, you can use `bundle add "authentik-api"` from the commandline.
+
+If you need compatibility with a specific authentik version, choose one of the following examples:
+
+```ruby
+# The latest `2026.2.x` series release, excluding release candidates.
+gem "authentik-api" "~> 2026.2.0"
+# An exact patch version tracking your authentik instance.
+gem "authentik-api" "2026.2.1"
+# To test out a release candidate, you have to specify the exact version.
+gem "authentik-api" "2026.5.0-rc1"
+# If you want to incorporate the latest (unreleased) changes, you can add this 
+# repo's GitHub source. It tracks authentik's main branch. Updates daily, but 
+# only when authentik's OpenAPI schema changes.
+gem "authentik-api", github: "david-uhlig/authentik-api"
+```
+
+## Usage
+
+Please see the auto-generated [API Readme]. Consider using the [authentik-client] gem for a friendlier wrapper around this auto-generated API client.
+
+## Versioning
+
+This library's versioning tracks authentik's versioning scheme of `<YYYY>.<M>.<PATCH>[<-PRERELEASE>]`, for example `2026.2.0-rc1`. Under the rare circumstance that the library itself needs an intermediate update, we add a fourth component, e.g. `2026.2.0.1-rc1`. Note: The prerelease component always appears last.
+
+## Changelog
+
+Please refer to the upstream [release notes](https://docs.goauthentik.io/releases/) for API changes.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt.
+
+Project structure:
+* The `.authentik/` directory holds the copy of authentik's `schema.yml` that was used to generate the OpenAPI Generator client.
+* In `.openapi-generator/` you will find configuration and template overwrites for the OpenAPI generator, and a [Zeitwerk] inflector to handle loading unconventional class names.
+* GitHub workflows in `.github/workflows` detect upstream releases, changes on the `schema.yml`, and auto-generate OpenAPI Generator clients. 
+
+To regenerate the underlying OpenAPI client manually run `bin/generate-api`. This requires Docker to be installed on your system.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/david-uhlig/authentik-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/david-uhlig/authentik-api/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE.md).
+
+## Attribution
+
+* [authentik]: The open-source IdP and SSO platform. Providing flexible and scalable authentication.
+* [OpenAPI Generator] project: Simplifies the generation of API clients from OpenAPI schemas.
+* [Zeitwerk] providing efficient code loading and excellent documentation.
+
+> [!NOTE]
+> This project is not affiliated with or endorsed by Authentik Security Inc.
+
+[authentik]: https://github.com/goauthentik/authentik
+[authentik-client]: https://github.com/david-uhlig/authentik-client
+[OpenAPI Generator]: https://openapi-generator.tech/
+[gem]: https://rubygems.org/gems/authentik-api
+[license]: https://github.com/david-uhlig/authentik-api/blob/main/LICENSE.md
+[tests]: https://github.com/david-uhlig/authentik-api/actions/workflows/main.yml
+[API Readme]: README_API.md
+[Zeitwerk]: https://github.com/fxn/zeitwerk