56 lines
2.4 KiB
Protocol Buffer
56 lines
2.4 KiB
Protocol Buffer
syntax = "proto3";
|
|
|
|
package controller.api.resources.groups.v1;
|
|
|
|
option go_package = "github.com/hashicorp/boundary/sdk/pbs/controller/api/resources/groups;groups";
|
|
|
|
import "google/protobuf/timestamp.proto";
|
|
import "google/protobuf/wrappers.proto";
|
|
import "controller/api/resources/scopes/v1/scope.proto";
|
|
import "controller/custom_options/v1/options.proto";
|
|
|
|
message Member {
|
|
// Output only. The ID of the member.
|
|
string id = 10; // @gotags: `class:"public"`
|
|
|
|
// Output only. The Scope ID of the member.
|
|
string scope_id = 20 [json_name="scope_id"]; // @gotags: `class:"public"`
|
|
}
|
|
|
|
// Group contains all fields related to a Group resource
|
|
message Group {
|
|
// Output only. The ID of the Group.
|
|
string id = 10; // @gotags: `class:"public"`
|
|
|
|
// The ID of the scope of which this Group is a part.
|
|
string scope_id = 20 [json_name="scope_id"]; // @gotags: `class:"public"`
|
|
|
|
// Output only. Scope information for this Group.
|
|
resources.scopes.v1.ScopeInfo scope = 30;
|
|
|
|
// Optional name for identification purposes.
|
|
google.protobuf.StringValue name = 40 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"name" that: "name"}]; // @gotags: `class:"public"`
|
|
|
|
// Optional user-set descripton for identification purposes.
|
|
google.protobuf.StringValue description = 50 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"description" that: "description"}]; // @gotags: `class:"public"`
|
|
|
|
// Output only. The time this resource was created.
|
|
google.protobuf.Timestamp created_time = 60 [json_name="created_time"]; // @gotags: `class:"public"`
|
|
|
|
// Output only. The time this resource was last updated.
|
|
google.protobuf.Timestamp updated_time = 70 [json_name="updated_time"]; // @gotags: `class:"public"`
|
|
|
|
// 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 = 80; // @gotags: `class:"public"`
|
|
|
|
// Output only. Contains the list of member IDs in this Group.
|
|
repeated string member_ids = 90 [json_name="member_ids"]; // @gotags: `class:"public"`
|
|
|
|
// Output only. The members of this Group.
|
|
repeated Member members = 100;
|
|
|
|
// Output only. The available actions on this resource for this user.
|
|
repeated string authorized_actions = 300 [json_name="authorized_actions"]; // @gotags: `class:"public"`
|
|
}
|