observation tags proto messages
This commit is contained in:
51 files changed
+458
-454
No files matched your search
@@ -17,7 +17,7 @@ option go_package = "github.com/hashicorp/boundary/sdk/pbs/controller/api/resour
|
||||
// Account contains all fields related to an Account resource
|
||||
message Account {
|
||||
// Output only. The ID of the Account.
|
||||
string id = 10; // @gotags: `class:"public"`
|
||||
string id = 10; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. Scope information for the Account.
|
||||
resources.scopes.v1.ScopeInfo scope = 20;
|
||||
@@ -41,23 +41,23 @@ message Account {
|
||||
]; // @gotags: `class:"public"`
|
||||
|
||||
// Output only. The time this resource was created.
|
||||
google.protobuf.Timestamp created_time = 50 [json_name = "created_time"]; // @gotags: `class:"public"`
|
||||
google.protobuf.Timestamp created_time = 50 [json_name = "created_time"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The time this resource was last updated.
|
||||
google.protobuf.Timestamp updated_time = 60 [json_name = "updated_time"]; // @gotags: `class:"public"`
|
||||
google.protobuf.Timestamp updated_time = 60 [json_name = "updated_time"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// 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; // @gotags: `class:"public"`
|
||||
uint32 version = 70; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// The type of this Account.
|
||||
string type = 80; // @gotags: `class:"public"`
|
||||
string type = 80; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// The ID of the Auth Method that is associated with this Account.
|
||||
string auth_method_id = 90 [
|
||||
json_name = "auth_method_id",
|
||||
(custom_options.v1.subtype_source_id) = true
|
||||
]; // @gotags: `class:"public"`
|
||||
]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
oneof attrs {
|
||||
// The attributes that are applicable for the specific Account type.
|
||||
@@ -83,10 +83,10 @@ message Account {
|
||||
}
|
||||
|
||||
// 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"]; // @gotags: `class:"public"`
|
||||
repeated string managed_group_ids = 110 [json_name = "managed_group_ids"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The available actions on this resource for this user.
|
||||
repeated string authorized_actions = 300 [json_name = "authorized_actions"]; // @gotags: `class:"public"`
|
||||
repeated string authorized_actions = 300 [json_name = "authorized_actions"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
}
|
||||
|
||||
// Attributes associated only with Accounts with type "password".
|
||||
|
||||
@@ -18,10 +18,10 @@ option (custom_options.v1.domain) = "auth";
|
||||
// AuthMethod contains all fields related to an Auth Method resource
|
||||
message AuthMethod {
|
||||
// Output only. The ID of the Auth Method.
|
||||
string id = 10; // @gotags: `class:"public"`
|
||||
string id = 10; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// The ID of the Scope of which this Auth Method is a part.
|
||||
string scope_id = 20 [json_name = "scope_id"]; // @gotags: `class:"public"`
|
||||
string scope_id = 20 [json_name = "scope_id"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. Scope information for this Auth method.
|
||||
resources.scopes.v1.ScopeInfo scope = 30;
|
||||
@@ -45,17 +45,17 @@ message AuthMethod {
|
||||
]; // @gotags: `class:"public"`
|
||||
|
||||
// Output only. The time this resource was created.
|
||||
google.protobuf.Timestamp created_time = 60 [json_name = "created_time"]; // @gotags: `class:"public"`
|
||||
google.protobuf.Timestamp created_time = 60 [json_name = "created_time"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The time this resource was last updated.
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name = "updated_time"]; // @gotags: `class:"public"`
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name = "updated_time"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// 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"`
|
||||
|
||||
// The Auth Method type.
|
||||
string type = 90; // @gotags: `class:"public"`
|
||||
string type = 90; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
oneof attrs {
|
||||
// The attributes that are applicable for the specific Auth Method type.
|
||||
@@ -82,10 +82,10 @@ message AuthMethod {
|
||||
|
||||
// Output only. Whether this auth method is the primary auth method for it's scope.
|
||||
// To change this value update the primary_auth_method_id field on the scope.
|
||||
bool is_primary = 110 [json_name = "is_primary"]; // @gotags: `class:"public"`
|
||||
bool is_primary = 110 [json_name = "is_primary"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The available actions on this resource for this user.
|
||||
repeated string authorized_actions = 300 [json_name = "authorized_actions"]; // @gotags: `class:"public"`
|
||||
repeated string authorized_actions = 300 [json_name = "authorized_actions"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The authorized actions for the scope's collections.
|
||||
map<string, google.protobuf.ListValue> authorized_collection_actions = 310 [json_name = "authorized_collection_actions"]; // classified as public via taggable implementation
|
||||
|
||||
@@ -14,19 +14,19 @@ option go_package = "github.com/hashicorp/boundary/sdk/pbs/controller/api/resour
|
||||
|
||||
message Member {
|
||||
// Output only. The ID of the member.
|
||||
string id = 10; // @gotags: `class:"public"`
|
||||
string id = 10; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The Scope ID of the member.
|
||||
string scope_id = 20 [json_name = "scope_id"]; // @gotags: `class:"public"`
|
||||
string scope_id = 20 [json_name = "scope_id"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
}
|
||||
|
||||
// Group contains all fields related to a Group resource
|
||||
message Group {
|
||||
// Output only. The ID of the Group.
|
||||
string id = 10; // @gotags: `class:"public"`
|
||||
string id = 10; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// The ID of the scope of which this Group is a part.
|
||||
string scope_id = 20 [json_name = "scope_id"]; // @gotags: `class:"public"`
|
||||
string scope_id = 20 [json_name = "scope_id"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. Scope information for this Group.
|
||||
resources.scopes.v1.ScopeInfo scope = 30;
|
||||
@@ -50,21 +50,21 @@ message Group {
|
||||
]; // @gotags: `class:"public"`
|
||||
|
||||
// Output only. The time this resource was created.
|
||||
google.protobuf.Timestamp created_time = 60 [json_name = "created_time"]; // @gotags: `class:"public"`
|
||||
google.protobuf.Timestamp created_time = 60 [json_name = "created_time"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The time this resource was last updated.
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name = "updated_time"]; // @gotags: `class:"public"`
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name = "updated_time"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// 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"`
|
||||
repeated string member_ids = 90 [json_name = "member_ids"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// 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"`
|
||||
repeated string authorized_actions = 300 [json_name = "authorized_actions"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
}
|
||||
@@ -17,10 +17,10 @@ option go_package = "github.com/hashicorp/boundary/sdk/pbs/controller/api/resour
|
||||
// HostCatalog manages Hosts and Host Sets
|
||||
message HostCatalog {
|
||||
// Output only. The ID of the host.
|
||||
string id = 10; // @gotags: `class:"public"`
|
||||
string id = 10; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// The ID of the Scope of which this Host Catalog is a part.
|
||||
string scope_id = 20 [json_name = "scope_id"]; // @gotags: `class:"public"`
|
||||
string scope_id = 20 [json_name = "scope_id"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. Scope information for this resource.
|
||||
resources.scopes.v1.ScopeInfo scope = 30;
|
||||
@@ -29,7 +29,7 @@ message HostCatalog {
|
||||
string plugin_id = 34 [
|
||||
json_name = "plugin_id",
|
||||
(custom_options.v1.generate_sdk_option) = true
|
||||
]; // @gotags: `class:"public"`
|
||||
]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. Plugin information for this resource.
|
||||
resources.plugins.v1.PluginInfo plugin = 35;
|
||||
@@ -53,17 +53,17 @@ message HostCatalog {
|
||||
]; // @gotags: `class:"public"`
|
||||
|
||||
// Output only. The time this resource was created.
|
||||
google.protobuf.Timestamp created_time = 60 [json_name = "created_time"]; // @gotags: `class:"public"`
|
||||
google.protobuf.Timestamp created_time = 60 [json_name = "created_time"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The time this resource was last updated.
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name = "updated_time"]; // @gotags: `class:"public"`
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name = "updated_time"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// 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"`
|
||||
|
||||
// The type of Host Catalog.
|
||||
string type = 90; // @gotags: `class:"public"`
|
||||
string type = 90; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
oneof attrs {
|
||||
// Attributes specific to the catalog type.
|
||||
@@ -80,7 +80,7 @@ message HostCatalog {
|
||||
string secrets_hmac = 120; // @gotags: `class:"public"`
|
||||
|
||||
// Output only. The available actions on this resource for this user.
|
||||
repeated string authorized_actions = 300 [json_name = "authorized_actions"]; // @gotags: `class:"public"`
|
||||
repeated string authorized_actions = 300 [json_name = "authorized_actions"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The authorized actions for the scope's collections.
|
||||
map<string, google.protobuf.ListValue> authorized_collection_actions = 310 [json_name = "authorized_collection_actions"]; // classified as public via taggable implementation
|
||||
|
||||
@@ -17,7 +17,7 @@ option go_package = "github.com/hashicorp/boundary/sdk/pbs/controller/api/resour
|
||||
// ManagedGroup contains all fields related to an ManagedGroup resource
|
||||
message ManagedGroup {
|
||||
// Output only. The ID of the ManagedGroup.
|
||||
string id = 10; // @gotags: `class:"public"`
|
||||
string id = 10; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. Scope information for the ManagedGroup.
|
||||
resources.scopes.v1.ScopeInfo scope = 20;
|
||||
@@ -41,23 +41,23 @@ message ManagedGroup {
|
||||
]; // @gotags: `class:"public"`
|
||||
|
||||
// Output only. The time this resource was created.
|
||||
google.protobuf.Timestamp created_time = 50 [json_name = "created_time"]; // @gotags: `class:"public"`
|
||||
google.protobuf.Timestamp created_time = 50 [json_name = "created_time"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The time this resource was last updated.
|
||||
google.protobuf.Timestamp updated_time = 60 [json_name = "updated_time"]; // @gotags: `class:"public"`
|
||||
google.protobuf.Timestamp updated_time = 60 [json_name = "updated_time"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// 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; // @gotags: `class:"public"`
|
||||
|
||||
// The type of this ManagedGroup.
|
||||
string type = 80; // @gotags: `class:"public"`
|
||||
string type = 80; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// The ID of the Auth Method that is associated with this ManagedGroup.
|
||||
string auth_method_id = 90 [
|
||||
json_name = "auth_method_id",
|
||||
(custom_options.v1.subtype_source_id) = true
|
||||
]; // @gotags: `class:"public"`
|
||||
]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
oneof attrs {
|
||||
// The attributes that are applicable for the specific ManagedGroup type.
|
||||
@@ -78,7 +78,7 @@ message ManagedGroup {
|
||||
}
|
||||
|
||||
// Output only. The IDs of the current set of members (accounts) that are associated with this ManagedGroup.
|
||||
repeated string member_ids = 110 [json_name = "member_ids"]; // @gotags: `class:"public"`
|
||||
repeated string member_ids = 110 [json_name = "member_ids"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The available actions on this resource for this user.
|
||||
repeated string authorized_actions = 300 [json_name = "authorized_actions"]; // @gotags: `class:"public"`
|
||||
|
||||
@@ -14,13 +14,13 @@ option go_package = "github.com/hashicorp/boundary/sdk/pbs/controller/api/resour
|
||||
|
||||
message Principal {
|
||||
// Output only. The ID of the principal.
|
||||
string id = 1; // @gotags: `class:"public"`
|
||||
string id = 1; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The type of the principal.
|
||||
string type = 2; // @gotags: `class:"public"`
|
||||
string type = 2; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The Scope of the principal.
|
||||
string scope_id = 3 [json_name = "scope_id"]; // @gotags: `class:"public"`
|
||||
string scope_id = 3 [json_name = "scope_id"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
}
|
||||
|
||||
message GrantJson {
|
||||
@@ -52,10 +52,10 @@ message Grant {
|
||||
// Role contains all fields related to a Role resource
|
||||
message Role {
|
||||
// Output only. The ID of the Role.
|
||||
string id = 10; // @gotags: `class:"public"`
|
||||
string id = 10; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// The ID of the Scope containing this Role.
|
||||
string scope_id = 20 [json_name = "scope_id"]; // @gotags: `class:"public"`
|
||||
string scope_id = 20 [json_name = "scope_id"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. Scope information for this resource.
|
||||
resources.scopes.v1.ScopeInfo scope = 30;
|
||||
@@ -79,10 +79,10 @@ message Role {
|
||||
]; // @gotags: `class:"public"`
|
||||
|
||||
// Output only. The time this resource was created.
|
||||
google.protobuf.Timestamp created_time = 60 [json_name = "created_time"]; // @gotags: `class:"public"`
|
||||
google.protobuf.Timestamp created_time = 60 [json_name = "created_time"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The time this resource was last updated.
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name = "updated_time"]; // @gotags: `class:"public"`
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name = "updated_time"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// 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.
|
||||
@@ -96,10 +96,10 @@ message Role {
|
||||
this: "grant_scope_id"
|
||||
that: "GrantScopeId"
|
||||
}
|
||||
]; // @gotags: `class:"public"`
|
||||
]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The IDs (only) of principals that are assigned to this role.
|
||||
repeated string principal_ids = 100 [json_name = "principal_ids"]; // @gotags: `class:"public"`
|
||||
repeated string principal_ids = 100 [json_name = "principal_ids"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The principals that are assigned to this role.
|
||||
repeated Principal principals = 110;
|
||||
|
||||
@@ -14,10 +14,10 @@ option go_package = "github.com/hashicorp/boundary/sdk/pbs/controller/api/resour
|
||||
|
||||
message ScopeInfo {
|
||||
// Output only. The ID of the Scope.
|
||||
string id = 1; // @gotags: `class:"public"`
|
||||
string id = 1; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The type of the Scope.
|
||||
string type = 2; // @gotags: `class:"public"`
|
||||
string type = 2; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The name of the Scope, if any.
|
||||
string name = 3; // @gotags: `class:"public"`
|
||||
@@ -26,16 +26,16 @@ message ScopeInfo {
|
||||
string description = 4; // @gotags: `class:"public"`
|
||||
|
||||
// Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.
|
||||
string parent_scope_id = 5 [json_name = "parent_scope_id"]; // @gotags: `class:"public"`
|
||||
string parent_scope_id = 5 [json_name = "parent_scope_id"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
}
|
||||
|
||||
// Scope contains all fields related to a Scope resource
|
||||
message Scope {
|
||||
// Output only. The ID of the Scope.
|
||||
string id = 10; // @gotags: `class:"public"`
|
||||
string id = 10; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// The ID of the Scope this resource is in. If this is the "global" Scope this field will be empty.
|
||||
string scope_id = 20 [json_name = "scope_id"]; // @gotags: `class:"public"`
|
||||
string scope_id = 20 [json_name = "scope_id"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. Scope information for this resource.
|
||||
ScopeInfo scope = 30;
|
||||
@@ -59,17 +59,17 @@ message Scope {
|
||||
]; // @gotags: `class:"public"`
|
||||
|
||||
// Output only. The time this resource was created.
|
||||
google.protobuf.Timestamp created_time = 60 [json_name = "created_time"]; // @gotags: `class:"public"`
|
||||
google.protobuf.Timestamp created_time = 60 [json_name = "created_time"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The time this resource was last updated.
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name = "updated_time"]; // @gotags: `class:"public"`
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name = "updated_time"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// 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"`
|
||||
|
||||
// The type of the resource.
|
||||
string type = 90; // @gotags: `class:"public"`
|
||||
string type = 90; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// The ID of the primary auth method for this scope. A primary auth method
|
||||
// is allowed to vivify users when new accounts are created and is the source for the users account info
|
||||
@@ -80,7 +80,7 @@ message Scope {
|
||||
this: "primary_auth_method_id"
|
||||
that: "PrimaryAuthMethodId"
|
||||
}
|
||||
]; // @gotags: `class:"public"`
|
||||
]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The available actions on this resource for this user.
|
||||
repeated string authorized_actions = 300 [json_name = "authorized_actions"]; // @gotags: `class:"public"`
|
||||
|
||||
@@ -12,13 +12,13 @@ option go_package = "github.com/hashicorp/boundary/sdk/pbs/controller/api/resour
|
||||
|
||||
message SessionState {
|
||||
// The status of the Session, e.g. "pending", "active", "canceling", "terminated".
|
||||
string status = 10; // @gotags: `class:"public"`
|
||||
string status = 10; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The time the Session entered this state.
|
||||
google.protobuf.Timestamp start_time = 20 [json_name = "start_time"]; // @gotags: `class:"public"`
|
||||
google.protobuf.Timestamp start_time = 20 [json_name = "start_time"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The time the Session stopped being in this state.
|
||||
google.protobuf.Timestamp end_time = 30 [json_name = "end_time"]; // @gotags: `class:"public"`
|
||||
google.protobuf.Timestamp end_time = 30 [json_name = "end_time"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
}
|
||||
|
||||
// Connection contains information about a specific connection in a session
|
||||
@@ -55,43 +55,43 @@ message Session {
|
||||
reserved "worker_info";
|
||||
|
||||
// Output only. The ID of the Session.
|
||||
string id = 10; // @gotags: `class:"public"`
|
||||
string id = 10; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The ID of the Target that created this Session.
|
||||
string target_id = 20 [json_name = "target_id"]; // @gotags: `class:"public"`
|
||||
string target_id = 20 [json_name = "target_id"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. Scope information for this resource.
|
||||
resources.scopes.v1.ScopeInfo scope = 30;
|
||||
|
||||
// Output only. The time this resource was created.
|
||||
google.protobuf.Timestamp created_time = 60 [json_name = "created_time"]; // @gotags: `class:"public"`
|
||||
google.protobuf.Timestamp created_time = 60 [json_name = "created_time"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The time this resource was last updated.
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name = "updated_time"]; // @gotags: `class:"public"`
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name = "updated_time"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Version is used when canceling this Session to ensure that the operation is acting on a known session state.
|
||||
uint32 version = 80; // @gotags: `class:"public"`
|
||||
|
||||
// Output only. Type of the Session (e.g. tcp).
|
||||
string type = 90; // @gotags: `class:"public"`
|
||||
string type = 90; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. After this time the connection will be expired, e.g. forcefully terminated.
|
||||
google.protobuf.Timestamp expiration_time = 100 [json_name = "expiration_time"]; // @gotags: `class:"public"`
|
||||
google.protobuf.Timestamp expiration_time = 100 [json_name = "expiration_time"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The ID of the Auth Token used to authenticate.
|
||||
string auth_token_id = 110 [json_name = "auth_token_id"]; // @gotags: `class:"public"`
|
||||
|
||||
// Output only. The ID of the User that requested the Session.
|
||||
string user_id = 120 [json_name = "user_id"]; // @gotags: `class:"public"`
|
||||
string user_id = 120 [json_name = "user_id"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The Host Set sourcing the Host for this Session.
|
||||
string host_set_id = 130 [json_name = "host_set_id"]; // @gotags: `class:"public"`
|
||||
string host_set_id = 130 [json_name = "host_set_id"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The Host used by the Session.
|
||||
string host_id = 140 [json_name = "host_id"]; // @gotags: `class:"public"`
|
||||
string host_id = 140 [json_name = "host_id"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The Scope of the Session.
|
||||
string scope_id = 150 [json_name = "scope_id"]; // @gotags: `class:"public"`
|
||||
string scope_id = 150 [json_name = "scope_id"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The endpoint of the Session; that is, the address to which the worker is proxying data.
|
||||
string endpoint = 160; // @gotags: `class:"public"`
|
||||
@@ -100,13 +100,13 @@ message Session {
|
||||
repeated SessionState states = 170;
|
||||
|
||||
// Output only. The current status of this Session.
|
||||
string status = 180; // @gotags: `class:"public"`
|
||||
string status = 180; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The certificate generated for the session. Raw DER bytes.
|
||||
bytes certificate = 200; // @gotags: `class:"public"`
|
||||
|
||||
// Output only. If the session is terminated, this provides a short description as to why.
|
||||
string termination_reason = 210 [json_name = "termination_reason"]; // @gotags: `class:"public"`
|
||||
string termination_reason = 210 [json_name = "termination_reason"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The available actions on this resource for this user.
|
||||
repeated string authorized_actions = 300 [json_name = "authorized_actions"]; // @gotags: `class:"public"`
|
||||
|
||||
@@ -16,10 +16,10 @@ option go_package = "github.com/hashicorp/boundary/sdk/pbs/controller/api/resour
|
||||
|
||||
message HostSource {
|
||||
// Output only. The ID of the Host Set.
|
||||
string id = 10; // @gotags: `class:"public"`
|
||||
string id = 10; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The Host Catalog to which this Host Source belongs.
|
||||
string host_catalog_id = 20 [json_name = "host_catalog_id"]; // @gotags: `class:"public"`
|
||||
string host_catalog_id = 20 [json_name = "host_catalog_id"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
}
|
||||
|
||||
message CredentialSource {
|
||||
@@ -72,10 +72,10 @@ message SessionCredential {
|
||||
// Target contains all fields related to a Target resource
|
||||
message Target {
|
||||
// Output only. The ID of the resource.
|
||||
string id = 10; // @gotags: `class:"public"`
|
||||
string id = 10; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// The Scope of of this resource. This must be defined for creation of this resource, but is otherwise output only.
|
||||
string scope_id = 20 [json_name = "scope_id"]; // @gotags: `class:"public"`
|
||||
string scope_id = 20 [json_name = "scope_id"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. Scope information for this resource.
|
||||
resources.scopes.v1.ScopeInfo scope = 30;
|
||||
@@ -99,20 +99,20 @@ message Target {
|
||||
]; // @gotags: `class:"public"`
|
||||
|
||||
// Output only. The time this resource was created.
|
||||
google.protobuf.Timestamp created_time = 60 [json_name = "created_time"]; // @gotags: `class:"public"`
|
||||
google.protobuf.Timestamp created_time = 60 [json_name = "created_time"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The time this resource was last updated.
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name = "updated_time"]; // @gotags: `class:"public"`
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name = "updated_time"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// 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"`
|
||||
|
||||
// The type of the Target.
|
||||
string type = 90; // @gotags: `class:"public"`
|
||||
string type = 90; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The IDs of the Host Sources associated with this Target.
|
||||
repeated string host_source_ids = 420 [json_name = "host_source_ids"]; // @gotags: `class:"public"`
|
||||
repeated string host_source_ids = 420 [json_name = "host_source_ids"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The Host Sources associated with this Target.
|
||||
repeated HostSource host_sources = 430 [json_name = "host_sources"];
|
||||
@@ -297,7 +297,7 @@ message SshTargetAttributes {
|
||||
this: "attributes.enable_session_recording"
|
||||
that: "EnableSessionRecording"
|
||||
}
|
||||
]; // @gotags: `class:"public"`
|
||||
]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
}
|
||||
|
||||
// WorkerInfo contains information about workers, returned in to the client in SessionAuthorization
|
||||
@@ -309,19 +309,19 @@ message WorkerInfo {
|
||||
// SessionAuthorizationData contains the fields needed by the proxy command to connect to a worker. It is marshaled inside the SessionAuthorization message.
|
||||
message SessionAuthorizationData {
|
||||
// Output only. The ID of the session.
|
||||
string session_id = 10 [json_name = "session_id"]; // @gotags: `class:"public"`
|
||||
string session_id = 10 [json_name = "session_id"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The ID of the Target authorizing this session.
|
||||
string target_id = 20 [json_name = "target_id"]; // @gotags: `class:"public"`
|
||||
string target_id = 20 [json_name = "target_id"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. Scope information for this the Target that authorized this session.
|
||||
resources.scopes.v1.ScopeInfo scope = 30;
|
||||
|
||||
// Output only. The time this resource was created.
|
||||
google.protobuf.Timestamp created_time = 40 [json_name = "created_time"]; // @gotags: `class:"public"`
|
||||
google.protobuf.Timestamp created_time = 40 [json_name = "created_time"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. Type of the session (e.g. tcp, ssh, etc.).
|
||||
string type = 80; // @gotags: `class:"public"`
|
||||
string type = 80; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The connection limit being applied to this session. -1 means unlimited. This is not actually enforced on the client side but it provides for better listener handling by including it.
|
||||
int32 connection_limit = 90 [json_name = "connection_limit"];
|
||||
@@ -333,7 +333,7 @@ message SessionAuthorizationData {
|
||||
bytes private_key = 130 [json_name = "private_key"]; // @gotags: `class:"secret"`
|
||||
|
||||
// Output only. The host ID...not used for security purposes, but for some special command handling (e.g. ssh host key aliasing).
|
||||
string host_id = 140; // @gotags: `class:"public"`
|
||||
string host_id = 140; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The endpoint, for some special command handling.
|
||||
string endpoint = 141; // @gotags: `class:"public"`
|
||||
@@ -348,28 +348,28 @@ message SessionAuthorizationData {
|
||||
// SessionAuthorization contains all fields related to authorization for a Session. It's in the Targets package because it's returned by a Target's authorize action.
|
||||
message SessionAuthorization {
|
||||
// Output only. The ID of the Session.
|
||||
string session_id = 10 [json_name = "session_id"]; // @gotags: `class:"public"`
|
||||
string session_id = 10 [json_name = "session_id"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The ID of the Target authorizing this Session.
|
||||
string target_id = 20 [json_name = "target_id"]; // @gotags: `class:"public"`
|
||||
string target_id = 20 [json_name = "target_id"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. Scope information for this resource.
|
||||
resources.scopes.v1.ScopeInfo scope = 30;
|
||||
|
||||
// Output only. The time this resource was created.
|
||||
google.protobuf.Timestamp created_time = 40 [json_name = "created_time"]; // @gotags: `class:"public"`
|
||||
google.protobuf.Timestamp created_time = 40 [json_name = "created_time"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The User for which this Session was authorized.
|
||||
string user_id = 50 [json_name = "user_id"]; // @gotags: `class:"public"`
|
||||
string user_id = 50 [json_name = "user_id"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The Host Set containing the Host being used for this Session.
|
||||
string host_set_id = 60 [json_name = "host_set_id"]; // @gotags: `class:"public"`
|
||||
string host_set_id = 60 [json_name = "host_set_id"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The Host whose address is being used as the endpoint for this Session.
|
||||
string host_id = 70 [json_name = "host_id"]; // @gotags: `class:"public"`
|
||||
string host_id = 70 [json_name = "host_id"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. Type of the Session (e.g. tcp, ssh, etc.).
|
||||
string type = 80; // @gotags: `class:"public"`
|
||||
string type = 80; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The marshaled SessionAuthorizationData message containing all information that the proxy needs.
|
||||
string authorization_token = 90 [json_name = "authorization_token"]; // @gotags: `class:"secret"`
|
||||
|
||||
@@ -14,19 +14,19 @@ option go_package = "github.com/hashicorp/boundary/sdk/pbs/controller/api/resour
|
||||
|
||||
message Account {
|
||||
// Output only. The ID of the Account.
|
||||
string id = 10; // @gotags: `class:"public"`
|
||||
string id = 10; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The Scope containing the Account.
|
||||
string scope_id = 20 [json_name = "scope_id"]; // @gotags: `class:"public"`
|
||||
string scope_id = 20 [json_name = "scope_id"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
}
|
||||
|
||||
// User contains all fields related to a User resource
|
||||
message User {
|
||||
// Output only. The ID of the User.
|
||||
string id = 10; // @gotags: `class:"public"`
|
||||
string id = 10; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// The ID of the Scope this resource is in.
|
||||
string scope_id = 20 [json_name = "scope_id"]; // @gotags: `class:"public"`
|
||||
string scope_id = 20 [json_name = "scope_id"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. Scope information for this resource.
|
||||
resources.scopes.v1.ScopeInfo scope = 30;
|
||||
@@ -50,17 +50,17 @@ message User {
|
||||
]; // @gotags: `class:"sensitive"`
|
||||
|
||||
// Output only. The time this resource was created.
|
||||
google.protobuf.Timestamp created_time = 60 [json_name = "created_time"]; // @gotags: `class:"public"`
|
||||
google.protobuf.Timestamp created_time = 60 [json_name = "created_time"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The time this resource was last updated.
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name = "updated_time"]; // @gotags: `class:"public"`
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name = "updated_time"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// 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 Account IDs linked to this User.
|
||||
repeated string account_ids = 90 [json_name = "account_ids"]; // @gotags: `class:"public"`
|
||||
repeated string account_ids = 90 [json_name = "account_ids"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The Accounts linked to this User.
|
||||
repeated Account accounts = 100;
|
||||
@@ -82,5 +82,5 @@ message User {
|
||||
|
||||
// Output only. primary_account_id is a string that maps to the user's account
|
||||
// public_id from the scope's primary auth method
|
||||
string primary_account_id = 140 [json_name = "primary_account_id"]; // @gotags: `class:"public"`
|
||||
string primary_account_id = 140 [json_name = "primary_account_id"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
}
|
||||
@@ -16,10 +16,10 @@ option go_package = "github.com/hashicorp/boundary/sdk/pbs/controller/api/resour
|
||||
// Worker contains all fields related to a Worker resource
|
||||
message Worker {
|
||||
// Output only. The ID of the User.
|
||||
string id = 10; // @gotags: `class:"public"`
|
||||
string id = 10; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// The ID of the Scope this resource is in.
|
||||
string scope_id = 20 [json_name = "scope_id"]; // @gotags: `class:"public"`
|
||||
string scope_id = 20 [json_name = "scope_id"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. Scope information for this resource.
|
||||
resources.scopes.v1.ScopeInfo scope = 30;
|
||||
@@ -45,10 +45,10 @@ message Worker {
|
||||
]; // @gotags: `class:"sensitive"`
|
||||
|
||||
// Output only. The time this resource was created.
|
||||
google.protobuf.Timestamp created_time = 60 [json_name = "created_time"]; // @gotags: `class:"public"`
|
||||
google.protobuf.Timestamp created_time = 60 [json_name = "created_time"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The time this resource was last updated.
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name = "updated_time"]; // @gotags: `class:"public"`
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name = "updated_time"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// 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.
|
||||
@@ -67,7 +67,7 @@ message Worker {
|
||||
map<string, google.protobuf.ListValue> config_tags = 130 [json_name = "config_tags"]; // @gotags: `class:"public"`
|
||||
|
||||
// Output only. The time this worker daemon last reported its status.
|
||||
google.protobuf.Timestamp last_status_time = 140 [json_name = "last_status_time"]; // @gotags: `class:"public"`
|
||||
google.protobuf.Timestamp last_status_time = 140 [json_name = "last_status_time"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// worker_generated_auth_token is input only. Supports the worker led node
|
||||
// enrollment flow where this credentials token is produced by a worker. This
|
||||
@@ -80,7 +80,7 @@ message Worker {
|
||||
google.protobuf.StringValue controller_generated_activation_token = 151 [json_name = "controller_generated_activation_token"]; // @gotags: `class:"secret"`
|
||||
|
||||
// Output only. The number of connections that this worker is currently handling.
|
||||
google.protobuf.UInt32Value active_connection_count = 160 [json_name = "active_connection_count"]; // @gotags: `class:"public"`
|
||||
google.protobuf.UInt32Value active_connection_count = 160 [json_name = "active_connection_count"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The type of the worker, denoted by how it authenticates: `pki`
|
||||
// or `kms`.
|
||||
@@ -90,10 +90,10 @@ message Worker {
|
||||
map<string, google.protobuf.ListValue> api_tags = 180 [json_name = "api_tags"]; // @gotags: `class:"public"`
|
||||
|
||||
// Output only. The version of the Boundary binary the worker is running.
|
||||
string release_version = 190 [json_name = "release_version"]; // @gotags: `class:"public"`
|
||||
string release_version = 190 [json_name = "release_version"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The ids of the workers directly connected to this worker.
|
||||
repeated string directly_connected_downstream_workers = 200 [json_name = "directly_connected_downstream_workers"]; // @gotags: `class:"public"`
|
||||
repeated string directly_connected_downstream_workers = 200 [json_name = "directly_connected_downstream_workers"]; // @gotags: `class:"public" eventstream:"observation"`
|
||||
|
||||
// Output only. The available actions on this resource for the requester.
|
||||
repeated string authorized_actions = 300 [json_name = "authorized_actions"]; // @gotags: `class:"public"`
|
||||
|
||||
Reference in new issue
Block a user