You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: webapp/src/service/apiSchema.generated.ts
+83-8Lines changed: 83 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -49,7 +49,7 @@ export interface paths {
49
49
"/v2/administration/apps": {
50
50
/** Returns the apps registered at server level — those belonging to no organization. The client secret is never disclosed here. */
51
51
get: operations["list_6"];
52
-
/** Fetches the manifest at the given URL and registers the app at server level, belonging to no organization. The response is the only place the client secret is ever disclosed. */
52
+
/** Fetches the manifest at the given URL and registers the app at server level, belonging to no organization. The response is the only place the client secret is ever disclosed. When an organization has already registered the same app, the native install is bound to that app and no app-level credentials are returned. */
53
53
post: operations["register_1"];
54
54
};
55
55
"/v2/administration/apps/preview": {
@@ -265,13 +265,17 @@ export interface paths {
265
265
"/v2/organizations/{organizationId}/apps": {
266
266
/** Returns all apps registered for the organization. */
267
267
get: operations["list_4"];
268
-
/** Fetches the manifest at the given URL and registers the app for the organization. */
269
-
post: operations["register"];
268
+
/** Fetches the manifest at the given URL and installs the app it describes for the organization. The app must already be registered on this server: when it is not, the call fails with the `app_not_registered` code, and the caller may register it — becoming its owner — through `POST /register`. The response is the only place the install's client secret is ever disclosed; app-level credentials are not disclosed here. */
/** Fetches the manifest at the given URL and returns its parsed contents (including the requested scopes) without persisting anything. Used by the registration UI to show a consent prompt before installing. */
/** Registers the app described by the manifest and installs it for the organization, in one operation. The organization becomes the app's owner, and the response is the only place the app-level credentials are ever disclosed. When the app is already registered — by another organization or by this one — it is only installed, and no app-level credentials are returned. */
/** @description The `id` declared in the app's manifest, unique across the server */
1707
+
appId: string;
1708
+
/** @description App-level OAuth client id. Present only in the response to registering the app — an organization that merely installed it never sees it. */
1709
+
clientId?: string;
1710
+
/** @description App-level OAuth client secret in plaintext. Administers the app across every organization that installed it and grants access to no data. Present only in the response to registering the app; Tolgee stores only a hash and cannot show it again. */
1711
+
clientSecret?: string;
1712
+
/** Format: int64 */
1713
+
id: number;
1714
+
name: string;
1715
+
/** @description The secret Tolgee signs this app's lifecycle deliveries with. Present only in the response to registering the app. */
/** Fetches the manifest at the given URL and registers the app at server level, belonging to no organization. The response is the only place the client secret is ever disclosed. */
8895
+
/** Fetches the manifest at the given URL and registers the app at server level, belonging to no organization. The response is the only place the client secret is ever disclosed. When an organization has already registered the same app, the native install is bound to that app and no app-level credentials are returned. */
/** Fetches the manifest at the given URL and registers the app for the organization. */
12085
-
register: {
12106
+
/** Fetches the manifest at the given URL and installs the app it describes for the organization. The app must already be registered on this server: when it is not, the call fails with the `app_not_registered` code, and the caller may register it — becoming its owner — through `POST /register`. The response is the only place the install's client secret is ever disclosed; app-level credentials are not disclosed here. */
/** Registers the app described by the manifest and installs it for the organization, in one operation. The organization becomes the app's owner, and the response is the only place the app-level credentials are ever disclosed. When the app is already registered — by another organization or by this one — it is only installed, and no app-level credentials are returned. */
0 commit comments