threshold/internal/proto/controller/api/services/v1/managed_group_service.proto

// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0

syntax = "proto3";

package controller.api.services.v1;

import "controller/api/resources/managedgroups/v1/managed_group.proto";
import "controller/custom_options/v1/options.proto";
import "google/api/annotations.proto";
import "google/protobuf/field_mask.proto";
import "protoc-gen-openapiv2/options/annotations.proto";

option go_package = "github.com/hashicorp/boundary/internal/gen/controller/api/services;services";
option (custom_options.v1.domain) = "auth";

service ManagedGroupService {
  option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_tag) = {
    name: "Managed group service"
    description:
      "A managed group is a resource that represents a collection of accounts. "
      "The managed group service provides endpoints for creating, reading, updating, and deleting managed groups in Boundary."
    external_docs: {
      url: "https://developer.hashicorp.com/boundary/docs/concepts/domain-model/managed-groups";
      description: "Read about managed groups in the Boundary domain model";
    }
  };

  // GetManagedGroup returns a stored ManagedGroup if present. The provided request must
  // include the id for the ManagedGroup be retrieved. If missing, malformed or
  // referencing a non existing ManagedGroup an error is returned.
  rpc GetManagedGroup(GetManagedGroupRequest) returns (GetManagedGroupResponse) {
    option (google.api.http) = {
      get: "/v1/managed-groups/{id}"
      response_body: "item"
    };
    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Gets a single ManagedGroup."};
  }

  // ListManagedGroups returns a list of stored ManagedGroups which exist inside the
  // provided Auth Method. The request must include the Auth Method id which
  // contains the ManagedGroups being listed. If missing or malformed, an error
  // is returned.
  rpc ListManagedGroups(ListManagedGroupsRequest) returns (ListManagedGroupsResponse) {
    option (google.api.http) = {get: "/v1/managed-groups"};
    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Lists all ManagedGroups in a specific Auth Method."};
  }

  // CreateManagedGroup creates and stores a ManagedGroup. The provided request
  // must include the Auth Method ID in which the ManagedGroup will be created.
  // If the Auth Method ID is missing, malformed, or references a non existing
  // resource an error is returned. If a name or login_name is provided that is
  // in use in another ManagedGroup in the same Auth Method an error is
  // returned.
  rpc CreateManagedGroup(CreateManagedGroupRequest) returns (CreateManagedGroupResponse) {
    option (google.api.http) = {
      post: "/v1/managed-groups"
      body: "item"
      response_body: "item"
    };
    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Creates a single ManagedGroup in the provided Auth Method."};
  }

  // UpdateManagedGroup updates an existing ManagedGroup. The provided
  // ManagedGroup must not have any read only fields set. The update mask must
  // be included in the request and contain at least 1 mutable field. To unset a
  // field's value, include the field in the update mask and don't set it in the
  // provided ManagedGroup. An error is returned if the ManagedGroup id is
  // missing or references a non-existing resource. An error is also returned if
  // the request attempts to update the name to one that is already in use in
  // the containing Auth Method.
  rpc UpdateManagedGroup(UpdateManagedGroupRequest) returns (UpdateManagedGroupResponse) {
    option (google.api.http) = {
      patch: "/v1/managed-groups/{id}"
      body: "item"
      response_body: "item"
    };
    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Updates a ManagedGroup."};
  }

  // DeleteManagedGroup removes a ManagedGroup. If the provided ManagedGroup Id
  // is malformed or not provided an error is returned.
  rpc DeleteManagedGroup(DeleteManagedGroupRequest) returns (DeleteManagedGroupResponse) {
    option (google.api.http) = {delete: "/v1/managed-groups/{id}"};
    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {summary: "Deletes a ManagedGroup."};
  }
}

message GetManagedGroupRequest {
  string id = 1; // @gotags: `class:"public" eventstream:"observation"`
}

message GetManagedGroupResponse {
  resources.managedgroups.v1.ManagedGroup item = 1;
}

message ListManagedGroupsRequest {
  string auth_method_id = 1 [json_name = "auth_method_id"]; // @gotags: `class:"public" eventstream:"observation"`
  // You can specify that the filter should only return items that match.
  // Refer to [filter expressions](https://developer.hashicorp.com/boundary/docs/concepts/filtering) for more information.
  string filter = 30 [json_name = "filter"]; // @gotags: `class:"public"`
  // An opaque token that Boundary uses to continue an existing iteration or
  // request updated items. If you do not specify a token, pagination
  // starts from the beginning. To learn more about list pagination
  // in Boundary, refer to [list pagination](https://developer.hashicorp.com/boundary/docs/api-clients/api/pagination).
  string list_token = 40 [json_name = "list_token"]; // @gotags: `class:"public"`
  // The maximum size of a page in this iteration.
  // If unset, the default page size configured will be used.
  // If the page_size is greater than the default page configured,
  // the page size will be truncated to this number..
  uint32 page_size = 50 [json_name = "page_size"]; // @gotags: `class:"public"`
}

message ListManagedGroupsResponse {
  repeated resources.managedgroups.v1.ManagedGroup items = 1;
  // The type of response, either "delta" or "complete".
  // Delta signifies that this is part of a paginated result
  // or an update to a previously completed pagination.
  // Complete signifies that it is the last page.
  string response_type = 2 [json_name = "response_type"]; // @gotags: `class:"public"`
  // An opaque token used to continue an existing pagination or
  // request updated items. Use this token in the next list request
  // to request the next page.
  string list_token = 3 [json_name = "list_token"]; // @gotags: `class:"public"`
  // The name of the field which the items are sorted by.
  string sort_by = 4 [json_name = "sort_by"]; // @gotags: `class:"public"`
  // The direction of the sort, either "asc" or "desc".
  string sort_dir = 5 [json_name = "sort_dir"]; // @gotags: `class:"public"`
  // A list of item IDs that have been removed since they were returned
  // as part of a pagination. They should be dropped from any client cache.
  // This may contain items that are not known to the cache, if they were
  // created and deleted between listings.
  repeated string removed_ids = 6 [json_name = "removed_ids"]; // @gotags: `class:"public"`
  // An estimate at the total items available. This may change during pagination.
  uint32 est_item_count = 7 [json_name = "est_item_count"]; // @gotags: `class:"public"`
}

message CreateManagedGroupRequest {
  resources.managedgroups.v1.ManagedGroup item = 2;
}

message CreateManagedGroupResponse {
  string uri = 1; // @gotags: `class:"public"`
  resources.managedgroups.v1.ManagedGroup item = 2;
}

message UpdateManagedGroupRequest {
  string id = 1; // @gotags: `class:"public" eventstream:"observation"`
  resources.managedgroups.v1.ManagedGroup item = 2;
  google.protobuf.FieldMask update_mask = 3 [json_name = "update_mask"];
}

message UpdateManagedGroupResponse {
  resources.managedgroups.v1.ManagedGroup item = 1;
}

message DeleteManagedGroupRequest {
  string id = 1; // @gotags: `class:"public" eventstream:"observation"`
}

message DeleteManagedGroupResponse {}