From 732217bc5eb6aa44ae0b071a26f858763a294016 Mon Sep 17 00:00:00 2001 From: Fabi Date: Fri, 15 Mar 2024 11:45:14 +0100 Subject: [PATCH] docs: add org id header in missing requests (#7562) * docs: add org id header in missing requests * docs: add org id header to proto definitions --------- Co-authored-by: Livio Spring --- proto/zitadel/management.proto | 80 ++++++++++++++++++++++++++++++++++ 1 file changed, 80 insertions(+) diff --git a/proto/zitadel/management.proto b/proto/zitadel/management.proto index 41cc1c69e2..284b070d5d 100644 --- a/proto/zitadel/management.proto +++ b/proto/zitadel/management.proto @@ -440,6 +440,14 @@ service ManagementService { description: "Create a new user with the type human. The newly created user will get an initialization email if either the email address is not marked as verified or no password is set. If a password is set the user will not be requested to set a new one on the first login." tags: "Users"; deprecated: true; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get/set a result of another organization include the header. Make sure the user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; }; } @@ -490,6 +498,14 @@ service ManagementService { description: "OK"; } }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; }; } @@ -513,6 +529,14 @@ service ManagementService { description: "OK"; } }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; }; } @@ -536,6 +560,14 @@ service ManagementService { description: "OK"; } }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; }; } @@ -559,6 +591,14 @@ service ManagementService { description: "OK"; } }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; }; } @@ -582,6 +622,14 @@ service ManagementService { description: "OK"; } }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; }; } @@ -604,6 +652,14 @@ service ManagementService { description: "OK"; } }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; }; } @@ -627,6 +683,14 @@ service ManagementService { description: "OK"; } }; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get a user from another organization include the header. Make sure the requesting user has permission in the requested organization."; + type: STRING, + required: false; + }; + }; }; } @@ -1147,6 +1211,14 @@ service ManagementService { tags: "User Human"; summary: "Set Human Initial Password"; deprecated: true; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get/set a result of another organization include the header. Make sure the user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; }; } @@ -4142,6 +4214,14 @@ service ManagementService { summary: "Get Org IAM Policy"; description: "Use Get Domain Settings instead" deprecated: true; + parameters: { + headers: { + name: "x-zitadel-orgid"; + description: "The default is always the organization of the requesting user. If you like to get/set a result of another organization include the header. Make sure the user has permission to access the requested data."; + type: STRING, + required: false; + }; + }; }; }