Managed Groups service (#1262)

This commit is contained in:
Jeff Mitchell authored and GitHub committed 2021-06-02 14:01:37 -04:00
1 parent 6c9b9e948e
commit 179a49657e
27 files changed
+4734 -120

No files matched your search

@@ -43,6 +43,9 @@ message Account {
// The attributes that are applicable for the specific Account type.
google.protobuf.Struct attributes = 100 [(custom_options.v1.generate_sdk_option) = true];
// Output only. managed_group_ids indicates IDs of the managed groups that currently contain this account
repeated string managed_group_ids = 110 [json_name="managed_group_ids"];
// Output only. The available actions on this resource for this user.
repeated string authorized_actions = 300 [json_name="authorized_actions"];
}
@@ -66,7 +69,7 @@ message OidcAccountAttributes {
// This value is immutable after creation time.
string subject = 90 [json_name="subject", (custom_options.v1.generate_sdk_option) = true];
// Output only. full_name is a string that maps to the OIDC name claim
// Output only. full_name is a string that maps to the OIDC name claim.
string full_name = 100 [json_name="full_name"];
// Output only. email is a string that maps to the OIDC email claim.
@@ -0,0 +1,54 @@
syntax = "proto3";
package controller.api.resources.managedgroups.v1;
option go_package = "github.com/hashicorp/boundary/internal/gen/controller/api/resources/managedgroups;managedgroups";
import "google/protobuf/timestamp.proto";
import "google/protobuf/wrappers.proto";
import "google/protobuf/struct.proto";
import "controller/api/resources/scopes/v1/scope.proto";
import "controller/custom_options/v1/options.proto";
// ManagedGroup contains all fields related to an ManagedGroup resource
message ManagedGroup {
// Output only. The ID of the ManagedGroup.
string id = 10;
// Output only. Scope information for the ManagedGroup.
resources.scopes.v1.ScopeInfo scope = 20;
// Optional name for identification purposes.
google.protobuf.StringValue name = 30 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"name" that: "Name"}];
// Optional user-set description for identification purposes.
google.protobuf.StringValue description = 40 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"description" that: "Description"}];
// Output only. The time this resource was created.
google.protobuf.Timestamp created_time = 50 [json_name="created_time"];
// Output only. The time this resource was last updated.
google.protobuf.Timestamp updated_time = 60 [json_name="updated_time"];
// Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
// The mutation will fail if the version does not match the latest known good version.
uint32 version = 70;
// The type of this ManagedGroup.
string type = 80;
// The ID of the Auth Method that is associated with this ManagedGroup.
string auth_method_id = 90 [json_name="auth_method_id"];
// The attributes that are applicable for the specific ManagedGroup type.
google.protobuf.Struct attributes = 100 [(custom_options.v1.generate_sdk_option) = true];
// Output only. The available actions on this resource for this user.
repeated string authorized_actions = 300 [json_name="authorized_actions"];
}
// Attributes associated only with ManagedGroups with type "oidc".
message OidcManagedGroupAttributes {
// The boolean expression filter to use to determine membership.
string filter = 10 [json_name="filter", (custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"attributes.filter" that: "Filter"}];
}
@@ -0,0 +1,129 @@
syntax = "proto3";
package controller.api.services.v1;
option go_package = "github.com/hashicorp/boundary/internal/gen/controller/api/services;services";
import "protoc-gen-openapiv2/options/annotations.proto";
import "google/api/annotations.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/wrappers.proto";
import "controller/api/resources/managedgroups/v1/managed_group.proto";
service ManagedGroupService {
// 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;
}
message GetManagedGroupResponse {
resources.managedgroups.v1.ManagedGroup item = 1;
}
message ListManagedGroupsRequest {
string auth_method_id = 1 [json_name="auth_method_id"];
string filter = 30 [json_name="filter"];
}
message ListManagedGroupsResponse {
repeated resources.managedgroups.v1.ManagedGroup items = 1;
}
message CreateManagedGroupRequest {
resources.managedgroups.v1.ManagedGroup item = 2;
}
message CreateManagedGroupResponse {
string uri = 1;
resources.managedgroups.v1.ManagedGroup item = 2;
}
message UpdateManagedGroupRequest {
string id = 1;
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;
}
message DeleteManagedGroupResponse {}