dataset/seed/oauth2-client/README.md

61 lines
4.9 KiB
Markdown
Raw Normal View History

2022-12-24 13:01:51 +01:00
---
gitea: none
include_toc: true
---
2023-08-11 09:38:05 +02:00
[Return to the list of application services.](../README.md)
2022-12-24 13:01:51 +01:00
# oauth2-client
2023-08-02 09:26:54 +02:00
## Synopsis
2022-12-24 13:01:51 +01:00
Application service needs interact with a Oauth2 server.
2023-08-11 09:38:05 +02:00
## Basic variables
2022-12-24 13:01:51 +01:00
2023-08-11 09:38:05 +02:00
### General
2022-12-24 13:01:51 +01:00
2023-08-02 09:26:54 +02:00
#### OAuth2 client
2022-12-24 13:01:51 +01:00
2023-08-11 09:38:05 +02:00
| Parameter | Comment |
2023-08-02 09:26:54 +02:00
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| **[general.oauth2_client.oauth2_client_name](dictionaries/30_oauth2_client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client name.<br/>**Example:** example |
| **[general.oauth2_client.oauth2_client_description](dictionaries/30_oauth2_client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client description.<br/>**Example:** Example description |
2023-08-11 09:38:05 +02:00
## Variables
### General
#### OAuth2 client
| Parameter | Comment |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------|
| **[general.oauth2_client.oauth2_client_login](dictionaries/30_oauth2_client.xml)**<br/>**Type:** [`web_address`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 URL to valid login. |
2022-12-24 13:01:51 +01:00
2023-08-02 09:26:54 +02:00
##### external
2022-12-24 13:01:51 +01:00
2023-08-02 09:26:54 +02:00
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|
| **[general.oauth2_client.external.oauth2_client_external](dictionaries/30_oauth2_client.xml)**<br/>mandatory, multiple<br/>**Type:** [`web_address`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client external.<br/>**Default:** *calculated* |
| **[general.oauth2_client.external.oauth2_client_family](dictionaries/30_oauth2_client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 family.<br/>**Default:** users |
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------|
| **[general.oauth2_client.oauth2_client_category](dictionaries/30_oauth2_client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 category.<br/>**Default:** Défaut |
| **[general.oauth2_client.oauth2_client_logo](dictionaries/30_oauth2_client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 logo.<br/>**Default:** demo.png |
2022-12-24 13:01:51 +01:00
2023-08-11 09:38:05 +02:00
2022-12-24 13:01:51 +01:00
## Used by
- [odoo](../odoo/README.md)
2023-06-29 18:56:46 +02:00
- [grafana](../grafana/README.md)
2022-12-24 13:01:51 +01:00
- [mailman](../mailman/README.md)
- [peertube](../peertube/README.md)
- [piwigo](../piwigo/README.md)
- [dovecot](../dovecot/README.md)
2023-01-17 21:43:32 +01:00
- [forgejo](../forgejo/README.md)
2022-12-24 13:01:51 +01:00
- [roundcube](../roundcube/README.md)
- [nextcloud](../nextcloud/README.md)