blueprints: support setting file URLs in blueprints (#5510)
* blueprints: support setting file URLs in blueprints Signed-off-by: Jens Langhammer <jens@goauthentik.io> * make new fields not required Signed-off-by: Jens Langhammer <jens@goauthentik.io> * include conditional fields in schema Signed-off-by: Jens Langhammer <jens@goauthentik.io> * update docs Signed-off-by: Jens Langhammer <jens@goauthentik.io> --------- Signed-off-by: Jens Langhammer <jens@goauthentik.io>
This commit is contained in:
@ -15,7 +15,7 @@ Blueprints are yaml files, whose format is described further in [File structure]
|
||||
- As a Blueprint instance, which is a YAML file mounted into the authentik (worker) container. This file is read and applied regularly (every 60 minutes). Multiple instances can be created for a single blueprint file, and instances can be given context key:value attributes to configure the blueprint.
|
||||
|
||||
:::info
|
||||
Starting with authentik 2022.12.1, authentik listens for file modification/creation events in the blueprint directory and will automatically trigger a discovery when a new blueprint file is created, and trigger a blueprint apply when a file is modified.
|
||||
Starting with authentik 2022.12.1, authentik watches for file modification/creation events in the blueprint directory and will automatically trigger a discovery when a new blueprint file is created, and trigger a blueprint apply when a file is modified.
|
||||
:::
|
||||
|
||||
- As a Flow import, which is a YAML file uploaded via the Browser/API. This file is validated and applied directly after being uploaded, but is not further monitored/applied.
|
||||
|
@ -1,6 +1,6 @@
|
||||
# Meta models
|
||||
|
||||
Since blueprints have a pretty strict mapping of each entry mapping to an instance of a model in the database, _meta models_ have been added to trigger other actions within authentik that don't directly map to a model.
|
||||
Since blueprints have a pretty strict mapping of each entry mapping to an instance of a model in the database, _meta models_ exist to trigger other actions within authentik that don't directly map to a model.
|
||||
|
||||
### `authentik_blueprints.metaapplyblueprint`
|
||||
|
||||
|
@ -25,3 +25,65 @@ For example:
|
||||
user: !KeyOf my-user
|
||||
intent: api
|
||||
```
|
||||
|
||||
### `authentik_core.application`
|
||||
|
||||
:::info
|
||||
Requires authentik 2023.5
|
||||
:::
|
||||
|
||||
Application icons can be directly set to URLs with the `icon` field.
|
||||
|
||||
For example:
|
||||
|
||||
```yaml
|
||||
# [...]
|
||||
- model: authentik_core.application
|
||||
identifiers:
|
||||
slug: my-app
|
||||
attrs:
|
||||
name: My App
|
||||
icon: https://goauthentik.io/img/icon.png
|
||||
```
|
||||
|
||||
### `authentik_sources_oauth.oauthsource`, `authentik_sources_saml.samlsource`, `authentik_sources_plex.plexsource`
|
||||
|
||||
:::info
|
||||
Requires authentik 2023.5
|
||||
:::
|
||||
|
||||
Source icons can be directly set to URLs with the `icon` field.
|
||||
|
||||
For example:
|
||||
|
||||
```yaml
|
||||
# [...]
|
||||
- model: authentik_sources_oauth.oauthsource
|
||||
identifiers:
|
||||
slug: my-source
|
||||
attrs:
|
||||
name: My source
|
||||
icon: https://goauthentik.io/img/icon.png
|
||||
```
|
||||
|
||||
### `authentik_flows.flow`
|
||||
|
||||
:::info
|
||||
Requires authentik 2023.5
|
||||
:::
|
||||
|
||||
Flow backgrounds can be directly set to URLs with the `background` field.
|
||||
|
||||
For example:
|
||||
|
||||
```yaml
|
||||
# [...]
|
||||
- model: authentik_flows.flow
|
||||
identifiers:
|
||||
slug: my-flow
|
||||
attrs:
|
||||
name: my-flow
|
||||
title: My flow
|
||||
designation: authentication
|
||||
background: https://goauthentik.io/img/icon.png
|
||||
```
|
||||
|
Reference in New Issue
Block a user