From: Dominik Csapak <d.csapak@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox-backup 3/6] api: access: domains: add ExtraRealmInfo and RealmInfo structs
Date: Fri, 9 Jul 2021 13:43:58 +0200 [thread overview]
Message-ID: <20210709114401.277841-4-d.csapak@proxmox.com> (raw)
In-Reply-To: <20210709114401.277841-1-d.csapak@proxmox.com>
these will be used as parameters/return types for the read/create/etc.
calls for realms
for now we copy the necessary attributes (only from openid) since
our api macros/tools are not good enought to generate the necessary
api definitions for section configs
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
---
src/api2/access/domain.rs | 65 +++++++++++++++++++++++++++++++++++++++
1 file changed, 65 insertions(+)
diff --git a/src/api2/access/domain.rs b/src/api2/access/domain.rs
index 126cd8ff..c850603a 100644
--- a/src/api2/access/domain.rs
+++ b/src/api2/access/domain.rs
@@ -8,6 +8,7 @@ use serde_json::{json, Value};
use proxmox::api::{api, Permission, Router, RpcEnvironment};
use crate::api2::types::*;
+use crate::config::domains::{OpenIdRealmConfig, OpenIdUserAttribute};
#[api]
#[derive(Deserialize, Serialize, PartialEq, Eq)]
@@ -50,6 +51,70 @@ pub struct BasicRealmInfo {
pub comment: Option<String>,
}
+#[api(
+ properties: {
+ "issuer-url": {
+ description: "OpenID Issuer Url",
+ type: String,
+ optional: true,
+ },
+ "client-id": {
+ description: "OpenID Client ID",
+ type: String,
+ optional: true,
+ },
+ "client-key": {
+ description: "OpenID Client Key",
+ type: String,
+ optional: true,
+ },
+ autocreate: {
+ description: "Automatically create users if they do not exist.",
+ optional: true,
+ type: bool,
+ default: false,
+ },
+ "username-claim": {
+ type: OpenIdUserAttribute,
+ optional: true,
+ },
+ },
+)]
+#[derive(Deserialize, Serialize)]
+#[serde(rename_all = "kebab-case")]
+/// Extra Information about a realm
+pub struct ExtraRealmInfo {
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub issuer_url: Option<String>,
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub client_id: Option<String>,
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub client_key: Option<String>,
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub autocreate: Option<bool>,
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub username_claim: Option<OpenIdUserAttribute>,
+}
+
+#[api(
+ properties: {
+ "info": {
+ type: BasicRealmInfo,
+ },
+ "extra": {
+ type: ExtraRealmInfo,
+ },
+ },
+)]
+#[derive(Deserialize, Serialize)]
+#[serde(rename_all = "kebab-case")]
+/// Information about a realm
+pub struct RealmInfo {
+ #[serde(flatten)]
+ pub info: BasicRealmInfo,
+ #[serde(flatten)]
+ pub extra: ExtraRealmInfo,
+}
#[api(
returns: {
--
2.30.2
next prev parent reply other threads:[~2021-07-09 11:44 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-07-09 11:43 [pbs-devel] [PATCH proxmox-backup 0/6] add realm api/ui Dominik Csapak
2021-07-09 11:43 ` [pbs-devel] [PATCH proxmox-backup 1/6] api: access: domains: add BasicRealmInfo struct and use it Dominik Csapak
2021-07-09 11:43 ` [pbs-devel] [PATCH proxmox-backup 2/6] config: acl: add PRIV_REALM_ALLOCATE Dominik Csapak
2021-07-09 11:43 ` Dominik Csapak [this message]
2021-07-09 11:43 ` [pbs-devel] [PATCH proxmox-backup 4/6] api: access: domains: add get/create/update/delete domain call Dominik Csapak
2021-07-09 11:44 ` [pbs-devel] [PATCH proxmox-backup 5/6] ui: add Authentication tab to Access Control Dominik Csapak
2021-07-09 11:44 ` [pbs-devel] [PATCH proxmox-backup 6/6] ui: add /access/domains to PermissionPathsStore Dominik Csapak
2021-07-12 4:11 ` [pbs-devel] applied-series: [PATCH proxmox-backup 0/6] add realm api/ui Thomas Lamprecht
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210709114401.277841-4-d.csapak@proxmox.com \
--to=d.csapak@proxmox.com \
--cc=pbs-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox