@origincloud/iam 0.32.0 → 0.34.0

package/dist/v1beta1/user.d.ts

@@ -2,9 +2,11 @@ import { type CallOptions, type Client, type Service } from "@origincloud/core";
 /**
  * Calls UserService.
  *
- * The signed-in user. Each user can read only their own profile, by the
- * name `users/me` or by their own id; the role bindings they hold are
- * listed by ListRoleBindings with the parent `organizations/-`.
+ * Users. Each user can read only their own profile, by the name `users/me`
+ * or by their own id; the role bindings they hold are listed by
+ * ListRoleBindings with the parent `organizations/-`. Anyone who may grant
+ * roles in an organization can look a user up by email address, to name
+ * them in a role binding.
  */
 export declare class UserClient {
     /**
@@ -20,6 +22,17 @@ export declare class UserClient {
      * profile.
      */
     getUser(request: GetUserRequest, options?: CallOptions): Promise<User>;
+    /**
+     * Looks up the user whose account has verified an email address, and
+     * answers them with their `name`: their full name is
+     * `//iam.origincloudapis.eu/` followed by it, which is how a role
+     * binding names them as a member. Needs `iam.role.assign` on
+     * `organization`, the permission a binding of the user needs anyway.
+     * Refused with `NOT_FOUND` when no enabled account has verified the
+     * address, and with `CONFLICT` when more than one has. The answer leaves
+     * `givenName` and `familyName` empty: only the user reads those.
+     */
+    lookupUser(request: LookupUserRequest, options?: CallOptions): Promise<User>;
 }
 /** A person who signs in to the platform. */
 export interface User {
@@ -47,4 +60,17 @@ export interface GetUserRequest {
     /** The user to return: `users/me`, or the caller's own `users/{user}`. */
     name?: string;
 }
+/** The request for LookupUser. */
+export interface LookupUserRequest {
+    /**
+     * The email address the user's account has verified, matched exactly,
+     * case aside.
+     */
+    email?: string;
+    /**
+     * The organization the caller looks the user up for, where it needs
+     * `iam.role.assign`: `organizations/{organization}`, or its full name.
+     */
+    organization?: string;
+}
 //# sourceMappingURL=user.d.ts.map

package/dist/v1beta1/user.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../src/v1beta1/user.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,MAAM,EAAE,KAAK,OAAO,EAAoB,MAAM,mBAAmB,CAAC;AAElG;;;;;;GAMG;AACH,qBAAa,UAAU;IACrB;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B,qEAAqE;gBACzD,MAAM,EAAE,MAAM;IAI1B;;;;OAIG;IACG,OAAO,CAAC,OAAO,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;CAc7E;AAED,6CAA6C;AAC7C,MAAM,WAAW,IAAI;IACnB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gDAAgD;IAChD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8CAA8C;IAC9C,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,8DAA8D;IAC9D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,+DAA+D;IAC/D,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,+BAA+B;AAC/B,MAAM,WAAW,cAAc;IAC7B,0EAA0E;IAC1E,IAAI,CAAC,EAAE,MAAM,CAAC;CACf"}
+{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../src/v1beta1/user.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,MAAM,EAAE,KAAK,OAAO,EAAoB,MAAM,mBAAmB,CAAC;AAElG;;;;;;;;GAQG;AACH,qBAAa,UAAU;IACrB;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B,qEAAqE;gBACzD,MAAM,EAAE,MAAM;IAI1B;;;;OAIG;IACG,OAAO,CAAC,OAAO,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAe5E;;;;;;;;;OASG;IACG,UAAU,CAAC,OAAO,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;CAWnF;AAED,6CAA6C;AAC7C,MAAM,WAAW,IAAI;IACnB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gDAAgD;IAChD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8CAA8C;IAC9C,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,8DAA8D;IAC9D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,+DAA+D;IAC/D,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,+BAA+B;AAC/B,MAAM,WAAW,cAAc;IAC7B,0EAA0E;IAC1E,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,kCAAkC;AAClC,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB"}

package/dist/v1beta1/user.js

@@ -4,9 +4,11 @@ import { pathValue, query } from "@origincloud/core";
 /**
  * Calls UserService.
  *
- * The signed-in user. Each user can read only their own profile, by the
- * name `users/me` or by their own id; the role bindings they hold are
- * listed by ListRoleBindings with the parent `organizations/-`.
+ * Users. Each user can read only their own profile, by the name `users/me`
+ * or by their own id; the role bindings they hold are listed by
+ * ListRoleBindings with the parent `organizations/-`. Anyone who may grant
+ * roles in an organization can look a user up by email address, to name
+ * them in a role binding.
  */
 export class UserClient {
     /**
@@ -35,5 +37,23 @@ export class UserClient {
             idempotent: true,
         }, options);
     }
+    /**
+     * Looks up the user whose account has verified an email address, and
+     * answers them with their `name`: their full name is
+     * `//iam.origincloudapis.eu/` followed by it, which is how a role
+     * binding names them as a member. Needs `iam.role.assign` on
+     * `organization`, the permission a binding of the user needs anyway.
+     * Refused with `NOT_FOUND` when no enabled account has verified the
+     * address, and with `CONFLICT` when more than one has. The answer leaves
+     * `givenName` and `familyName` empty: only the user reads those.
+     */
+    async lookupUser(request, options) {
+        return this.service.call({
+            method: "GET",
+            path: `/v1beta1/users:lookup`,
+            query: query(request, []),
+            idempotent: true,
+        }, options);
+    }
 }
 //# sourceMappingURL=user.js.map

package/dist/v1beta1/user.js.map

@@ -1 +1 @@
-{"version":3,"file":"user.js","sourceRoot":"","sources":["../../src/v1beta1/user.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,6CAA6C;AAE7C,OAAO,EAA+C,SAAS,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAElG;;;;;;GAMG;AACH,MAAM,OAAO,UAAU;IACrB;;;OAGG;IACM,OAAO,CAAU;IAE1B,qEAAqE;IACrE,YAAY,MAAc;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAO,CAAC,OAAuB,EAAE,OAAqB;QAC1D,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;QACpE,MAAM,EAAE,GAAG,SAAS,CAAC,MAAM,EAAE,EAAE,EAAE,SAAS,CAAC,CAAC;QAC5C,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC;YAAE,OAAO,GAAG,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,YAAY,EAAE,EAAE;YACtB,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC;YAC/B,UAAU,EAAE,IAAI;SACjB,EACD,OAAO,CACR,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"user.js","sourceRoot":"","sources":["../../src/v1beta1/user.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,6CAA6C;AAE7C,OAAO,EAA+C,SAAS,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAElG;;;;;;;;GAQG;AACH,MAAM,OAAO,UAAU;IACrB;;;OAGG;IACM,OAAO,CAAU;IAE1B,qEAAqE;IACrE,YAAY,MAAc;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAO,CAAC,OAAuB,EAAE,OAAqB;QAC1D,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;QACpE,MAAM,EAAE,GAAG,SAAS,CAAC,MAAM,EAAE,EAAE,EAAE,SAAS,CAAC,CAAC;QAC5C,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC;YAAE,OAAO,GAAG,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,YAAY,EAAE,EAAE;YACtB,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC;YAC/B,UAAU,EAAE,IAAI;SACjB,EACD,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,UAAU,CAAC,OAA0B,EAAE,OAAqB;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,uBAAuB;YAC7B,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;YACzB,UAAU,EAAE,IAAI;SACjB,EACD,OAAO,CACR,CAAC;IACJ,CAAC;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@origincloud/iam",
-  "version": "0.32.0",
+  "version": "0.34.0",
   "description": "Origin Cloud's IAM service: users, service accounts, roles, role bindings, permissions and the audit log.",
   "license": "Apache-2.0",
   "homepage": "https://github.com/origincloudhq/sdk-typescript#readme",
@@ -34,9 +34,9 @@
     "!dist/**/*.tsbuildinfo"
   ],
   "peerDependencies": {
-    "@origincloud/core": "^0.32.0"
+    "@origincloud/core": "^0.34.0"
   },
   "devDependencies": {
-    "@origincloud/core": "^0.32.0"
+    "@origincloud/core": "^0.34.0"
   }
 }

package/src/v1beta1/user.ts

@@ -6,9 +6,11 @@ import { type CallOptions, type Client, type Service, pathValue, query } from "@
 /**
  * Calls UserService.
  *
- * The signed-in user. Each user can read only their own profile, by the
- * name `users/me` or by their own id; the role bindings they hold are
- * listed by ListRoleBindings with the parent `organizations/-`.
+ * Users. Each user can read only their own profile, by the name `users/me`
+ * or by their own id; the role bindings they hold are listed by
+ * ListRoleBindings with the parent `organizations/-`. Anyone who may grant
+ * roles in an organization can look a user up by email address, to name
+ * them in a role binding.
  */
 export class UserClient {
   /**
@@ -41,6 +43,28 @@ export class UserClient {
       options,
     );
   }
+
+  /**
+   * Looks up the user whose account has verified an email address, and
+   * answers them with their `name`: their full name is
+   * `//iam.origincloudapis.eu/` followed by it, which is how a role
+   * binding names them as a member. Needs `iam.role.assign` on
+   * `organization`, the permission a binding of the user needs anyway.
+   * Refused with `NOT_FOUND` when no enabled account has verified the
+   * address, and with `CONFLICT` when more than one has. The answer leaves
+   * `givenName` and `familyName` empty: only the user reads those.
+   */
+  async lookupUser(request: LookupUserRequest, options?: CallOptions): Promise<User> {
+    return this.service.call<User>(
+      {
+        method: "GET",
+        path: `/v1beta1/users:lookup`,
+        query: query(request, []),
+        idempotent: true,
+      },
+      options,
+    );
+  }
 }
 
 /** A person who signs in to the platform. */
@@ -70,3 +94,17 @@ export interface GetUserRequest {
   /** The user to return: `users/me`, or the caller's own `users/{user}`. */
   name?: string;
 }
+
+/** The request for LookupUser. */
+export interface LookupUserRequest {
+  /**
+   * The email address the user's account has verified, matched exactly,
+   * case aside.
+   */
+  email?: string;
+  /**
+   * The organization the caller looks the user up for, where it needs
+   * `iam.role.assign`: `organizations/{organization}`, or its full name.
+   */
+  organization?: string;
+}