60 lines
4.9 KiB
Markdown
60 lines
4.9 KiB
Markdown
---
|
|
gitea: none
|
|
include_toc: true
|
|
---
|
|
|
|
|
|
[Return to the list of application services.](../README.md)
|
|
# oauth2-client
|
|
|
|
## Synopsis
|
|
|
|
Application service needs interact with a Oauth2 server.
|
|
|
|
## Basic variables
|
|
|
|
### General
|
|
|
|
#### OAuth2 client
|
|
|
|
| Parameter | Comment |
|
|
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
|
|
| **[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 |
|
|
|
|
|
|
|
|
## 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. |
|
|
|
|
##### external
|
|
|
|
| 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 |
|
|
|
|
|
|
## Used by
|
|
|
|
- [odoo](../odoo/README.md)
|
|
- [grafana](../grafana/README.md)
|
|
- [mailman](../mailman/README.md)
|
|
- [peertube](../peertube/README.md)
|
|
- [piwigo](../piwigo/README.md)
|
|
- [dovecot](../dovecot/README.md)
|
|
- [forgejo](../forgejo/README.md)
|
|
- [roundcube](../roundcube/README.md)
|
|
- [nextcloud](../nextcloud/README.md)
|