@alis-build/alis-open-iam-v1 1.22.0 → 1.24.0

package/alis/open/iam/v1/group_pb.d.ts

@@ -1,7 +1,34 @@
-// @generated by protoc-gen-es v2.13.0 with parameter "target=js+dts,import_extension=js,json_types=true"
+// @generated by protoc-gen-es v2.16.0 with parameter "target=js+dts,import_extension=js,json_types=true"
 // @generated from file alis/open/iam/v1/group.proto (package alis.open.iam.v1, syntax proto3)
 /* eslint-disable */
 
+// Manages the users, groups, and roles of an Alis product deployment, and
+// configures how its users sign in.
+//
+// Services:
+//
+// - `UsersService` manages `User` resources (`users/{user}`). Besides the
+//   standard methods it has self-service RPCs for the signed-in user
+//   (`RetrieveMyUser`, `EditMyInfo`, `EditMyMetadata`, `RemoveMyUser`) and
+//   masked reads (`MaskedUser`) that hide sensitive details such as the email
+//   address.
+// - `GroupsService` manages `Group` resources (`groups/{group}`), groups of
+//   users.
+//
+// Both services expose the `google.iam.v1` policy RPCs plus `AddIamBindings`
+// and `RemoveIamBindings`. The request messages for those two RPCs are defined
+// here and reused by other packages for their own IAM-protected resources.
+//
+// Other types:
+//
+// - `Role` (`roles/{role}`): a set of permissions, usually gRPC method names,
+//   that can be bound to principals on the listed resource types.
+// - `IamConfig`: optional deployment config that creates an Alis-managed OAuth
+//   reverse proxy endpoint, with its auth providers, self-signup rules and
+//   cookie domains.
+// - `IdentityProvider`: the providers a user can sign in with (Google,
+//   Microsoft, email, LinkedIn, Apple).
+
 import type { GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
 import type { Message } from "@bufbuild/protobuf";
 import type { EmptySchema, FieldMask, FieldMaskJson, Timestamp, TimestampJson } from "@bufbuild/protobuf/wkt";
@@ -15,60 +42,86 @@ import type { AddIamBindingsRequestSchema, RemoveIamBindingsRequestSchema } from
 export declare const file_alis_open_iam_v1_group: GenFile;
 
 /**
+ * A group of users
+ *
  * @generated from message alis.open.iam.v1.Group
  */
 export declare type Group = Message<"alis.open.iam.v1.Group"> & {
   /**
+   * The unique name of the Group which cannot be changed.
+   * Format: groups/([a-z0-9-]{2,50})
+   *
    * @generated from field: string name = 1;
    */
   name: string;
 
   /**
+   * The display name of the group
+   *
    * @generated from field: string display_name = 2;
    */
   displayName: string;
 
   /**
+   * The description of the group
+   *
    * @generated from field: string description = 3;
    */
   description: string;
 
   /**
+   * The time the group was last updated
+   *
    * @generated from field: google.protobuf.Timestamp update_time = 98;
    */
   updateTime?: Timestamp | undefined;
 
   /**
+   * The time the group was created
+   *
    * @generated from field: google.protobuf.Timestamp create_time = 99;
    */
   createTime?: Timestamp | undefined;
 };
 
 /**
+ * A group of users
+ *
  * @generated from message alis.open.iam.v1.Group
  */
 export declare type GroupJson = {
   /**
+   * The unique name of the Group which cannot be changed.
+   * Format: groups/([a-z0-9-]{2,50})
+   *
    * @generated from field: string name = 1;
    */
   name?: string;
 
   /**
+   * The display name of the group
+   *
    * @generated from field: string display_name = 2;
    */
   displayName?: string;
 
   /**
+   * The description of the group
+   *
    * @generated from field: string description = 3;
    */
   description?: string;
 
   /**
+   * The time the group was last updated
+   *
    * @generated from field: google.protobuf.Timestamp update_time = 98;
    */
   updateTime?: TimestampJson;
 
   /**
+   * The time the group was created
+   *
    * @generated from field: google.protobuf.Timestamp create_time = 99;
    */
   createTime?: TimestampJson;
@@ -81,30 +134,46 @@ export declare type GroupJson = {
 export declare const GroupSchema: GenMessage<Group, {jsonType: GroupJson}>;
 
 /**
+ * The request message for the GetGroup method.
+ *
  * @generated from message alis.open.iam.v1.GetGroupRequest
  */
 export declare type GetGroupRequest = Message<"alis.open.iam.v1.GetGroupRequest"> & {
   /**
+   * The unique name of the Group.
+   * Format: groups/([a-z0-9-]{2,50})
+   *
    * @generated from field: string name = 1;
    */
   name: string;
 
   /**
+   * The fields to return in snake_case.
+   * All fields are returned if not set.
+   *
    * @generated from field: google.protobuf.FieldMask read_mask = 2;
    */
   readMask?: FieldMask | undefined;
 };
 
 /**
+ * The request message for the GetGroup method.
+ *
  * @generated from message alis.open.iam.v1.GetGroupRequest
  */
 export declare type GetGroupRequestJson = {
   /**
+   * The unique name of the Group.
+   * Format: groups/([a-z0-9-]{2,50})
+   *
    * @generated from field: string name = 1;
    */
   name?: string;
 
   /**
+   * The fields to return in snake_case.
+   * All fields are returned if not set.
+   *
    * @generated from field: google.protobuf.FieldMask read_mask = 2;
    */
   readMask?: FieldMaskJson;
@@ -117,20 +186,28 @@ export declare type GetGroupRequestJson = {
 export declare const GetGroupRequestSchema: GenMessage<GetGroupRequest, {jsonType: GetGroupRequestJson}>;
 
 /**
+ * The request message for the CreateGroup method.
+ *
  * @generated from message alis.open.iam.v1.CreateGroupRequest
  */
 export declare type CreateGroupRequest = Message<"alis.open.iam.v1.CreateGroupRequest"> & {
   /**
+   * The group to create
+   *
    * @generated from field: alis.open.iam.v1.Group group = 1;
    */
   group?: Group | undefined;
 };
 
 /**
+ * The request message for the CreateGroup method.
+ *
  * @generated from message alis.open.iam.v1.CreateGroupRequest
  */
 export declare type CreateGroupRequestJson = {
   /**
+   * The group to create
+   *
    * @generated from field: alis.open.iam.v1.Group group = 1;
    */
   group?: GroupJson;
@@ -143,30 +220,42 @@ export declare type CreateGroupRequestJson = {
 export declare const CreateGroupRequestSchema: GenMessage<CreateGroupRequest, {jsonType: CreateGroupRequestJson}>;
 
 /**
+ * Request message for the UpdateGroup method.
+ *
  * @generated from message alis.open.iam.v1.UpdateGroupRequest
  */
 export declare type UpdateGroupRequest = Message<"alis.open.iam.v1.UpdateGroupRequest"> & {
   /**
+   * The group to update
+   *
    * @generated from field: alis.open.iam.v1.Group group = 1;
    */
   group?: Group | undefined;
 
   /**
+   * The set of fields that should be updated
+   *
    * @generated from field: google.protobuf.FieldMask update_mask = 2;
    */
   updateMask?: FieldMask | undefined;
 };
 
 /**
+ * Request message for the UpdateGroup method.
+ *
  * @generated from message alis.open.iam.v1.UpdateGroupRequest
  */
 export declare type UpdateGroupRequestJson = {
   /**
+   * The group to update
+   *
    * @generated from field: alis.open.iam.v1.Group group = 1;
    */
   group?: GroupJson;
 
   /**
+   * The set of fields that should be updated
+   *
    * @generated from field: google.protobuf.FieldMask update_mask = 2;
    */
   updateMask?: FieldMaskJson;
@@ -179,20 +268,30 @@ export declare type UpdateGroupRequestJson = {
 export declare const UpdateGroupRequestSchema: GenMessage<UpdateGroupRequest, {jsonType: UpdateGroupRequestJson}>;
 
 /**
+ * The request message for the DeleteGroup method.
+ *
  * @generated from message alis.open.iam.v1.DeleteGroupRequest
  */
 export declare type DeleteGroupRequest = Message<"alis.open.iam.v1.DeleteGroupRequest"> & {
   /**
+   * The unique name of the Group.
+   * Format: groups/([a-z0-9-]{2,50})
+   *
    * @generated from field: string name = 1;
    */
   name: string;
 };
 
 /**
+ * The request message for the DeleteGroup method.
+ *
  * @generated from message alis.open.iam.v1.DeleteGroupRequest
  */
 export declare type DeleteGroupRequestJson = {
   /**
+   * The unique name of the Group.
+   * Format: groups/([a-z0-9-]{2,50})
+   *
    * @generated from field: string name = 1;
    */
   name?: string;
@@ -205,50 +304,72 @@ export declare type DeleteGroupRequestJson = {
 export declare const DeleteGroupRequestSchema: GenMessage<DeleteGroupRequest, {jsonType: DeleteGroupRequestJson}>;
 
 /**
+ * The request message for the ListGroups method.
+ *
  * @generated from message alis.open.iam.v1.ListGroupsRequest
  */
 export declare type ListGroupsRequest = Message<"alis.open.iam.v1.ListGroupsRequest"> & {
   /**
+   * The maximum number of Groups to return.
+   *
    * @generated from field: int32 page_size = 2;
    */
   pageSize: number;
 
   /**
+   * A page token, received from a previous ListGroups call.
+   *
    * @generated from field: string page_token = 3;
    */
   pageToken: string;
 
   /**
+   * The fields to return in snake_case.
+   * All fields are returned if not set.
+   *
    * @generated from field: google.protobuf.FieldMask read_mask = 4;
    */
   readMask?: FieldMask | undefined;
 
   /**
+   * The filter to apply.
+   *
    * @generated from field: string filter = 5;
    */
   filter: string;
 };
 
 /**
+ * The request message for the ListGroups method.
+ *
  * @generated from message alis.open.iam.v1.ListGroupsRequest
  */
 export declare type ListGroupsRequestJson = {
   /**
+   * The maximum number of Groups to return.
+   *
    * @generated from field: int32 page_size = 2;
    */
   pageSize?: number;
 
   /**
+   * A page token, received from a previous ListGroups call.
+   *
    * @generated from field: string page_token = 3;
    */
   pageToken?: string;
 
   /**
+   * The fields to return in snake_case.
+   * All fields are returned if not set.
+   *
    * @generated from field: google.protobuf.FieldMask read_mask = 4;
    */
   readMask?: FieldMaskJson;
 
   /**
+   * The filter to apply.
+   *
    * @generated from field: string filter = 5;
    */
   filter?: string;
@@ -261,30 +382,42 @@ export declare type ListGroupsRequestJson = {
 export declare const ListGroupsRequestSchema: GenMessage<ListGroupsRequest, {jsonType: ListGroupsRequestJson}>;
 
 /**
+ * The response message for the ListGroups method.
+ *
  * @generated from message alis.open.iam.v1.ListGroupsResponse
  */
 export declare type ListGroupsResponse = Message<"alis.open.iam.v1.ListGroupsResponse"> & {
   /**
+   * The Groups.
+   *
    * @generated from field: repeated alis.open.iam.v1.Group groups = 1;
    */
   groups: Group[];
 
   /**
+   * A token to retrieve the next page of results.
+   *
    * @generated from field: string next_page_token = 2;
    */
   nextPageToken: string;
 };
 
 /**
+ * The response message for the ListGroups method.
+ *
  * @generated from message alis.open.iam.v1.ListGroupsResponse
  */
 export declare type ListGroupsResponseJson = {
   /**
+   * The Groups.
+   *
    * @generated from field: repeated alis.open.iam.v1.Group groups = 1;
    */
   groups?: GroupJson[];
 
   /**
+   * A token to retrieve the next page of results.
+   *
    * @generated from field: string next_page_token = 2;
    */
   nextPageToken?: string;
@@ -297,20 +430,30 @@ export declare type ListGroupsResponseJson = {
 export declare const ListGroupsResponseSchema: GenMessage<ListGroupsResponse, {jsonType: ListGroupsResponseJson}>;
 
 /**
+ * The request message for the SyncGroup method.
+ *
  * @generated from message alis.open.iam.v1.SyncGroupRequest
  */
 export declare type SyncGroupRequest = Message<"alis.open.iam.v1.SyncGroupRequest"> & {
   /**
+   * The group to sync
+   * Format: groups/*
+   *
    * @generated from field: string group = 1;
    */
   group: string;
 };
 
 /**
+ * The request message for the SyncGroup method.
+ *
  * @generated from message alis.open.iam.v1.SyncGroupRequest
  */
 export declare type SyncGroupRequestJson = {
   /**
+   * The group to sync
+   * Format: groups/*
+   *
    * @generated from field: string group = 1;
    */
   group?: string;
@@ -323,12 +466,16 @@ export declare type SyncGroupRequestJson = {
 export declare const SyncGroupRequestSchema: GenMessage<SyncGroupRequest, {jsonType: SyncGroupRequestJson}>;
 
 /**
+ * The response message for the SyncGroup method.
+ *
  * @generated from message alis.open.iam.v1.SyncGroupResponse
  */
 export declare type SyncGroupResponse = Message<"alis.open.iam.v1.SyncGroupResponse"> & {
 };
 
 /**
+ * The response message for the SyncGroup method.
+ *
  * @generated from message alis.open.iam.v1.SyncGroupResponse
  */
 export declare type SyncGroupResponseJson = {
@@ -341,10 +488,14 @@ export declare type SyncGroupResponseJson = {
 export declare const SyncGroupResponseSchema: GenMessage<SyncGroupResponse, {jsonType: SyncGroupResponseJson}>;
 
 /**
+ * GroupsService provides RPCs for managing group resources.
+ *
  * @generated from service alis.open.iam.v1.GroupsService
  */
 export declare const GroupsService: GenService<{
   /**
+   * Gets the IAM policy for a resource implemented in this service.
+   *
    * @generated from rpc alis.open.iam.v1.GroupsService.GetIamPolicy
    */
   getIamPolicy: {
@@ -353,6 +504,8 @@ export declare const GroupsService: GenService<{
     output: typeof PolicySchema;
   },
   /**
+   * Sets the IAM policy for a resource implemented in this service.
+   *
    * @generated from rpc alis.open.iam.v1.GroupsService.SetIamPolicy
    */
   setIamPolicy: {
@@ -361,6 +514,8 @@ export declare const GroupsService: GenService<{
     output: typeof PolicySchema;
   },
   /**
+   * Returns permissions that a caller has on the specified resource.
+   *
    * @generated from rpc alis.open.iam.v1.GroupsService.TestIamPermissions
    */
   testIamPermissions: {
@@ -369,6 +524,8 @@ export declare const GroupsService: GenService<{
     output: typeof TestIamPermissionsResponseSchema;
   },
   /**
+   * Adds principals or updates the roles existing principals have on an IAM Policy protected resource.
+   *
    * @generated from rpc alis.open.iam.v1.GroupsService.AddIamBindings
    */
   addIamBindings: {
@@ -377,6 +534,8 @@ export declare const GroupsService: GenService<{
     output: typeof PolicySchema;
   },
   /**
+   * Removes principals or some of the roles they have on an IAM Policy protected resource.
+   *
    * @generated from rpc alis.open.iam.v1.GroupsService.RemoveIamBindings
    */
   removeIamBindings: {
@@ -385,6 +544,8 @@ export declare const GroupsService: GenService<{
     output: typeof PolicySchema;
   },
   /**
+   * Gets information about a Group.
+   *
    * @generated from rpc alis.open.iam.v1.GroupsService.GetGroup
    */
   getGroup: {
@@ -393,6 +554,8 @@ export declare const GroupsService: GenService<{
     output: typeof GroupSchema;
   },
   /**
+   * Creates a new Group.
+   *
    * @generated from rpc alis.open.iam.v1.GroupsService.CreateGroup
    */
   createGroup: {
@@ -401,6 +564,8 @@ export declare const GroupsService: GenService<{
     output: typeof GroupSchema;
   },
   /**
+   * Updates a Group.
+   *
    * @generated from rpc alis.open.iam.v1.GroupsService.UpdateGroup
    */
   updateGroup: {
@@ -409,6 +574,8 @@ export declare const GroupsService: GenService<{
     output: typeof GroupSchema;
   },
   /**
+   * Deletes a Group.
+   *
    * @generated from rpc alis.open.iam.v1.GroupsService.DeleteGroup
    */
   deleteGroup: {
@@ -417,6 +584,8 @@ export declare const GroupsService: GenService<{
     output: typeof EmptySchema;
   },
   /**
+   * Lists Groups. Results are sorted by name, ascending.
+   *
    * @generated from rpc alis.open.iam.v1.GroupsService.ListGroups
    */
   listGroups: {
@@ -425,6 +594,8 @@ export declare const GroupsService: GenService<{
     output: typeof ListGroupsResponseSchema;
   },
   /**
+   * Syncs the specified group to its list of users
+   *
    * @generated from rpc alis.open.iam.v1.GroupsService.SyncGroup
    */
   syncGroup: {

package/alis/open/iam/v1/group_pb.js

@@ -1,7 +1,34 @@
-// @generated by protoc-gen-es v2.13.0 with parameter "target=js+dts,import_extension=js,json_types=true"
+// @generated by protoc-gen-es v2.16.0 with parameter "target=js+dts,import_extension=js,json_types=true"
 // @generated from file alis/open/iam/v1/group.proto (package alis.open.iam.v1, syntax proto3)
 /* eslint-disable */
 
+// Manages the users, groups, and roles of an Alis product deployment, and
+// configures how its users sign in.
+//
+// Services:
+//
+// - `UsersService` manages `User` resources (`users/{user}`). Besides the
+//   standard methods it has self-service RPCs for the signed-in user
+//   (`RetrieveMyUser`, `EditMyInfo`, `EditMyMetadata`, `RemoveMyUser`) and
+//   masked reads (`MaskedUser`) that hide sensitive details such as the email
+//   address.
+// - `GroupsService` manages `Group` resources (`groups/{group}`), groups of
+//   users.
+//
+// Both services expose the `google.iam.v1` policy RPCs plus `AddIamBindings`
+// and `RemoveIamBindings`. The request messages for those two RPCs are defined
+// here and reused by other packages for their own IAM-protected resources.
+//
+// Other types:
+//
+// - `Role` (`roles/{role}`): a set of permissions, usually gRPC method names,
+//   that can be bound to principals on the listed resource types.
+// - `IamConfig`: optional deployment config that creates an Alis-managed OAuth
+//   reverse proxy endpoint, with its auth providers, self-signup rules and
+//   cookie domains.
+// - `IdentityProvider`: the providers a user can sign in with (Google,
+//   Microsoft, email, LinkedIn, Apple).
+
 import { fileDesc, messageDesc, serviceDesc } from "@bufbuild/protobuf/codegenv2";
 import { file_alis_open_iam_v1_iam } from "./iam_pb.js";
 import { file_google_iam_v1_iam_policy } from "@alis-build/google-iam-v1/google/iam/v1/iam_policy_pb.js";
@@ -78,6 +105,8 @@ export const SyncGroupResponseSchema = /*@__PURE__*/
   messageDesc(file_alis_open_iam_v1_group, 8);
 
 /**
+ * GroupsService provides RPCs for managing group resources.
+ *
  * @generated from service alis.open.iam.v1.GroupsService
  */
 export const GroupsService = /*@__PURE__*/