Sanitize protos (#471)
This commit is contained in:
1 parent
63224d094e
commit
b1fc9fd547
69 files changed
+2793
-3847
No files matched your search
@@ -10,39 +10,33 @@ import "google/protobuf/struct.proto";
|
||||
import "controller/api/resources/scopes/v1/scope.proto";
|
||||
import "controller/custom_options/v1/options.proto";
|
||||
|
||||
// Account contains all fields related to an auth Account resource
|
||||
// Account contains all fields related to an Account resource
|
||||
message Account {
|
||||
// The ID of the Account
|
||||
// Output only.
|
||||
// Output only. The ID of the Account.
|
||||
string id = 10;
|
||||
|
||||
// Scope information for this resource
|
||||
// Output only.
|
||||
// Output only. Scope information for the Account.
|
||||
resources.scopes.v1.ScopeInfo scope = 20;
|
||||
|
||||
// Optional name for identification purposes
|
||||
// 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 descripton for identification purposes
|
||||
// Optional user-set descripton for identification purposes.
|
||||
google.protobuf.StringValue description = 40 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"description" that: "description"}];
|
||||
|
||||
// The time this resource was created
|
||||
// Output only.
|
||||
// Output only. The time this resource was created.
|
||||
google.protobuf.Timestamp created_time = 50 [json_name="created_time"];
|
||||
|
||||
// The time this resource was last updated.
|
||||
// Output only.
|
||||
// Output only. The time this resource was last updated.
|
||||
google.protobuf.Timestamp updated_time = 60 [json_name="updated_time"];
|
||||
|
||||
// The version can be used in subsequent write requests to ensure this resource
|
||||
// has not changed and to fail the write if it has.
|
||||
// Version can be used in subsequent write requests to ensure this resource has not changed and to fail the write if it has.
|
||||
uint32 version = 70;
|
||||
|
||||
// The type of this account. Possible values are: "password", "oidc".
|
||||
// The type of this Account.
|
||||
string type = 80;
|
||||
|
||||
// The auth method this account is created for.
|
||||
// Output only.
|
||||
// Output only. The ID of the Auth Method that is associated with this Account.
|
||||
string auth_method_id = 90 [json_name="auth_method_id"];
|
||||
|
||||
// The attributes that are applicable for the specific Account type.
|
||||
@@ -50,8 +44,9 @@ message Account {
|
||||
}
|
||||
|
||||
message PasswordAccountAttributes {
|
||||
// The login name of this account. This is unique per auth method.
|
||||
string login_name = 10 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"attributes.login_name" that: "LoginName"}];
|
||||
// The password for this account.
|
||||
// The login name of this Account. This is unique per Auth Method.
|
||||
string login_name = 10 [json_name="login_name", (custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"attributes.login_name" that: "LoginName"}];
|
||||
|
||||
// The password for this Account.
|
||||
google.protobuf.StringValue password = 20 [(custom_options.v1.generate_sdk_option) = true];
|
||||
}
|
||||
@@ -10,48 +10,43 @@ import "google/protobuf/struct.proto";
|
||||
import "controller/api/resources/scopes/v1/scope.proto";
|
||||
import "controller/custom_options/v1/options.proto";
|
||||
|
||||
// AuthMethod contains all fields related to a AuthMethod resource
|
||||
// AuthMethod contains all fields related to an Auth Method resource
|
||||
message AuthMethod {
|
||||
// The ID of the AuthMethod
|
||||
// Output only.
|
||||
// Output only. The ID of the Auth Method.
|
||||
string id = 10;
|
||||
|
||||
// The id of the scope this resource is a part of
|
||||
// The ID of the Scope of which this Auth Method is a part.
|
||||
string scope_id = 20 [json_name="scope_id"];
|
||||
|
||||
// Scope information for this resource
|
||||
// Output only.
|
||||
// Output only. Scope information for this Auth method.
|
||||
resources.scopes.v1.ScopeInfo scope = 30;
|
||||
|
||||
// Optional name for identification purposes
|
||||
// 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"}];
|
||||
|
||||
// Optional user-set description for identification purposes
|
||||
// Optional user-set description for identification purposes.
|
||||
google.protobuf.StringValue description = 50 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"description" that: "description"}];
|
||||
|
||||
// The time this resource was created
|
||||
// Output only.
|
||||
// Output only. The time this resource was created.
|
||||
google.protobuf.Timestamp created_time = 60 [json_name="created_time"];
|
||||
|
||||
// The time this resource was last updated.
|
||||
// Output only.
|
||||
// Output only. The time this resource was last updated.
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name="updated_time"];
|
||||
|
||||
// The version can be used in subsequent write requests to ensure this resource
|
||||
// has not changed and to fail the write if it has.
|
||||
// Version can be used in subsequent write requests to ensure this resource has not changed and to fail the write if it has.
|
||||
uint32 version = 80;
|
||||
|
||||
// The auth method type. This can be "password" or "oidc".
|
||||
// The Auth Method type.
|
||||
string type = 90;
|
||||
|
||||
// The attributes that are applied for the specific Auth Method type.
|
||||
// The attributes that are applicable for the specific Auth Method type.
|
||||
google.protobuf.Struct attributes = 100 [(custom_options.v1.generate_sdk_option) = true];
|
||||
}
|
||||
|
||||
message PasswordAuthMethodAttributes {
|
||||
// The minimum length allowed for user names for accounts in this auth method.
|
||||
uint32 min_login_name_length = 10 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"attributes.min_login_name_length" that: "MinLoginNameLength"}];
|
||||
// The minimum length allowed for user names for Accounts in this Auth Method.
|
||||
uint32 min_login_name_length = 10 [json_name="min_login_name_length", (custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"attributes.min_login_name_length" that: "MinLoginNameLength"}];
|
||||
|
||||
// The minimum length allowed for passwords for accounts in this auth method.
|
||||
uint32 min_password_length = 20 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"attributes.min_password_length" that: "MinPasswordLength"}];
|
||||
// The minimum length allowed for passwords for Accounts in this Auth Method.
|
||||
uint32 min_password_length = 20 [json_name="min_password_length", (custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"attributes.min_password_length" that: "MinPasswordLength"}];
|
||||
}
|
||||
@@ -8,50 +8,38 @@ import "google/protobuf/timestamp.proto";
|
||||
import "google/protobuf/wrappers.proto";
|
||||
import "controller/api/resources/scopes/v1/scope.proto";
|
||||
|
||||
// AuthToken contains all fields related to an AuthToken resource
|
||||
// AuthToken contains all fields related to an Auth Token resource
|
||||
message AuthToken {
|
||||
// The ID of the AuthToken
|
||||
// Output only.
|
||||
// Output only. The ID of the Auth Token.
|
||||
string id = 10;
|
||||
|
||||
// The scope this auth token is in.
|
||||
// The Scope in which this Auth Token was generated.
|
||||
string scope_id = 20 [json_name="scope_id"];
|
||||
|
||||
// Scope information for this resource
|
||||
// Output only.
|
||||
// Output only. Scope information for this resource.
|
||||
resources.scopes.v1.ScopeInfo scope = 30;
|
||||
|
||||
// The token value, which will only be populated after authentication and is
|
||||
// only ever visible to the end user whose login request resulted in this
|
||||
// auth token being created.
|
||||
// Output only.
|
||||
// Output only. The token value, which will only be populated after authentication and is only ever visible to the end user whose login request resulted in this Auth Token being created.
|
||||
string token = 40;
|
||||
|
||||
// The id of the user of this AuthToken.
|
||||
// Output only.
|
||||
// Output only. The ID of the User associated with this Auth Token.
|
||||
string user_id = 50 [json_name="user_id"];
|
||||
|
||||
// The id of the auth method of this AuthToken.
|
||||
// Output only.
|
||||
// Output only. The ID of the Auth Method associated with this Auth Token.
|
||||
string auth_method_id = 60 [json_name="auth_method_id"];
|
||||
|
||||
// The id of the auth method account of this AuthToken.
|
||||
// Output only.
|
||||
// Output only. The ID of the Account associated with this Auth Token.
|
||||
string account_id = 70 [json_name="account_id"];
|
||||
|
||||
// The time this resource was created
|
||||
// Output only.
|
||||
// Output only. The time this resource was created.
|
||||
google.protobuf.Timestamp created_time = 80 [json_name="created_time"];
|
||||
|
||||
// The time this resource was last updated.
|
||||
// Output only.
|
||||
// Output only. The time this resource was last updated.
|
||||
google.protobuf.Timestamp updated_time = 90 [json_name="updated_time"];
|
||||
|
||||
// The approximate time this AuthToken was last used.
|
||||
// Output only.
|
||||
// Output only. The approximate time this Auth Token was last used.
|
||||
google.protobuf.Timestamp approximate_last_used_time = 100 [json_name = "approximate_last_used_time"];
|
||||
|
||||
// The time this AuthToken expires.
|
||||
// Output only.
|
||||
// Output only. The time this Auth Token expires.
|
||||
google.protobuf.Timestamp expiration_time = 110 [json_name="expiration_time"];
|
||||
}
|
||||
@@ -10,51 +10,42 @@ import "controller/api/resources/scopes/v1/scope.proto";
|
||||
import "controller/custom_options/v1/options.proto";
|
||||
|
||||
message Member {
|
||||
// The ID of the member.
|
||||
// Output only.
|
||||
// Output only. The ID of the member.
|
||||
string id = 10;
|
||||
|
||||
// The scope ID of the member.
|
||||
// Output only.
|
||||
// Output only. The Scope ID of the member.
|
||||
string scope_id = 20 [json_name="scope_id"];
|
||||
}
|
||||
|
||||
// Group contains all fields related to a Group resource
|
||||
message Group {
|
||||
// The ID of the Project
|
||||
// Output only.
|
||||
// Output only. The ID of the Group.
|
||||
string id = 10;
|
||||
|
||||
// The id of the scope this resource is a part of.
|
||||
// The ID of the scope of which this Group is a part.
|
||||
string scope_id = 20 [json_name="scope_id"];
|
||||
|
||||
// Scope information for this resource
|
||||
// Output only.
|
||||
// Output only. Scope information for this Group.
|
||||
resources.scopes.v1.ScopeInfo scope = 30;
|
||||
|
||||
// Optional name for identification purposes
|
||||
// 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"}];
|
||||
|
||||
// Optional user-set descripton for identification purposes
|
||||
// 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"}];
|
||||
|
||||
// The time this resource was created
|
||||
// Output only.
|
||||
// Output only. The time this resource was created.
|
||||
google.protobuf.Timestamp created_time = 60 [json_name="created_time"];
|
||||
|
||||
// The time this resource was last updated.
|
||||
// Output only.
|
||||
// Output only. The time this resource was last updated.
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name="updated_time"];
|
||||
|
||||
// The version can be used in subsequent write requests to ensure this resource
|
||||
// has not changed and to fail the write if it has.
|
||||
// Version can be used in subsequent write requests to ensure this resource has not changed and to fail the write if it has.
|
||||
uint32 version = 80;
|
||||
|
||||
// Contains the list of member ids in this group.
|
||||
// Output only.
|
||||
repeated string member_ids = 90;
|
||||
// Output only. Contains the list of member IDs in this Group.
|
||||
repeated string member_ids = 90 [json_name="member_ids"];
|
||||
|
||||
// The members of this group.
|
||||
// Output only.
|
||||
// Output only. The members of this Group.
|
||||
repeated Member members = 100;
|
||||
}
|
||||
@@ -10,40 +10,35 @@ import "google/protobuf/struct.proto";
|
||||
import "controller/api/resources/scopes/v1/scope.proto";
|
||||
import "controller/custom_options/v1/options.proto";
|
||||
|
||||
// HostCatalog manages Hosts and HostSets
|
||||
// HostCatalog manages Hosts and Host Sets
|
||||
message HostCatalog {
|
||||
// The ID of the host
|
||||
// Output only.
|
||||
// Output only. The ID of the host.
|
||||
string id = 10;
|
||||
|
||||
// The id of the scope this resource belongs to.
|
||||
// The ID of the Scope of which this Host Catalog is a part.
|
||||
string scope_id = 20 [json_name="scope_id"];
|
||||
|
||||
// Scope information for this resource
|
||||
// Output only.
|
||||
// Output only. Scope information for this resource.
|
||||
resources.scopes.v1.ScopeInfo scope = 30;
|
||||
|
||||
// Optional name for identification purposes
|
||||
// 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"}];
|
||||
|
||||
// Optional user-set description for identification purposes
|
||||
// Optional user-set description for identification purposes.
|
||||
google.protobuf.StringValue description = 50 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"description" that: "description"}];
|
||||
|
||||
// The time this resource was created
|
||||
// Output only.
|
||||
// Output only. The time this resource was created.
|
||||
google.protobuf.Timestamp created_time = 60 [json_name="created_time"];
|
||||
|
||||
// The time this resource was last updated
|
||||
// Output only.
|
||||
// Output only. The time this resource was last updated.
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name="updated_time"];
|
||||
|
||||
// The version can be used in subsequent write requests to ensure this resource
|
||||
// has not changed and to fail the write if it has.
|
||||
// Version can be used in subsequent write requests to ensure this resource has not changed and to fail the write if it has.
|
||||
uint32 version = 80;
|
||||
|
||||
// The type of the resource, to help differentiate schemas
|
||||
// The type of Host Catalog.
|
||||
string type = 90;
|
||||
|
||||
// Attributes specific to the catalog type
|
||||
// Attributes specific to the catalog type.
|
||||
google.protobuf.Struct attributes = 100 [(custom_options.v1.generate_sdk_option) = true];
|
||||
}
|
||||
@@ -12,48 +12,41 @@ import "controller/custom_options/v1/options.proto";
|
||||
|
||||
// Host contains all fields related to a Host resource
|
||||
message Host {
|
||||
// The ID of the host
|
||||
// Output only.
|
||||
// Output only. The ID of the Host.
|
||||
string id = 10;
|
||||
|
||||
// The host catalog this host set is a part of
|
||||
// Output only
|
||||
// Output only. The Host Catalog of which this Host is a part.
|
||||
string host_catalog_id = 20 [json_name="host_catalog_id"];
|
||||
|
||||
// Scope information for this resource
|
||||
// Output only.
|
||||
// Output only. Scope information for this resource.
|
||||
resources.scopes.v1.ScopeInfo scope = 30;
|
||||
|
||||
// Optional name for identification purposes
|
||||
// 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"}];
|
||||
|
||||
// Optional user-set description for identification purposes
|
||||
// Optional user-set description for identification purposes.
|
||||
google.protobuf.StringValue description = 50 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"description" that: "description"}];
|
||||
|
||||
// The time this resource was created
|
||||
// Output only.
|
||||
// Output only. The time this resource was created.
|
||||
google.protobuf.Timestamp created_time = 60 [json_name="created_time"];
|
||||
|
||||
// The time this resource was last updated
|
||||
// Output only.
|
||||
// Output only. The time this resource was last updated.
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name="updated_time"];
|
||||
|
||||
// The version can be used in subsequent write requests to ensure this resource
|
||||
// has not changed and to fail the write if it has.
|
||||
// Version can be used in subsequent write requests to ensure this resource has not changed and to fail the write if it has.
|
||||
uint32 version = 80;
|
||||
|
||||
// The type of the resource, to help differentiate schemas
|
||||
// The type of the resource.
|
||||
string type = 90;
|
||||
|
||||
// A list of host sets this host is in
|
||||
// Output only.
|
||||
repeated string host_set_ids = 100;
|
||||
// Output only. A list of Host Sets containing this Host.
|
||||
repeated string host_set_ids = 100 [json_name="host_set_ids"];
|
||||
|
||||
// The attributes that are applied for the specific host type.
|
||||
// The attributes that are applicable to the specific Host type.
|
||||
google.protobuf.Struct attributes = 110 [(custom_options.v1.generate_sdk_option) = true];
|
||||
}
|
||||
|
||||
message StaticHostAttributes {
|
||||
// The address (DNS or IP name) used to reach the host
|
||||
// The address (DNS or IP name) used to reach the Host.
|
||||
google.protobuf.StringValue address = 10 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"attributes.address" that: "address"}];
|
||||
}
|
||||
@@ -11,47 +11,38 @@ import "controller/api/resources/hosts/v1/host.proto";
|
||||
import "controller/api/resources/scopes/v1/scope.proto";
|
||||
import "controller/custom_options/v1/options.proto";
|
||||
|
||||
// HostSet is a collection of Hosts created and managed by a HostCatalog
|
||||
// HostSet is a collection of Hosts created and managed by a Host Catalog
|
||||
message HostSet {
|
||||
// The ID of the host
|
||||
// Output only.
|
||||
// Output only. The ID of the host.
|
||||
string id = 10;
|
||||
|
||||
// Scope information for this resource
|
||||
// Output only.
|
||||
resources.scopes.v1.ScopeInfo scope = 20;
|
||||
// Output only. The Host Catalog of which this Host Set is a part.
|
||||
string host_catalog_id = 20 [json_name="host_catalog_id"];
|
||||
|
||||
// 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"}];
|
||||
// Output only. Scope information for this resource.
|
||||
resources.scopes.v1.ScopeInfo scope = 30;
|
||||
|
||||
// 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"}];
|
||||
// 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"}];
|
||||
|
||||
// The time this resource was created
|
||||
// Output only.
|
||||
google.protobuf.Timestamp created_time = 50 [json_name="created_time"];
|
||||
// Optional user-set description for identification purposes.
|
||||
google.protobuf.StringValue description = 50 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"description" that: "description"}];
|
||||
|
||||
// The time this resource was last updated
|
||||
// Output only.
|
||||
google.protobuf.Timestamp updated_time = 60 [json_name="updated_time"];
|
||||
// Output only. The time this resource was created.
|
||||
google.protobuf.Timestamp created_time = 60 [json_name="created_time"];
|
||||
|
||||
// The version can be used in subsequent write requests to ensure this resource
|
||||
// has not changed and to fail the write if it has.
|
||||
uint32 version = 70;
|
||||
// Output only. The time this resource was last updated.
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name="updated_time"];
|
||||
|
||||
// The type of the resource, to help differentiate schemas
|
||||
string type = 80;
|
||||
// Version can be used in subsequent write requests to ensure this resource has not changed and to fail the write if it has.
|
||||
uint32 version = 80;
|
||||
|
||||
// The host catalog this host set is a part of
|
||||
// Output only
|
||||
string host_catalog_id = 90 [json_name="host_catalog_id"];
|
||||
// The type of the Host Set.
|
||||
string type = 90;
|
||||
|
||||
// A list of hosts in this host set
|
||||
// TODO: Figure out if this should be in the basic HostSet view and what
|
||||
// view to use on the Hosts.
|
||||
// Output only.
|
||||
repeated string host_ids = 100;
|
||||
// Output only. A list of Hosts in this Host Set.
|
||||
repeated string host_ids = 100 [json_name="host_ids"];
|
||||
|
||||
// The attributes that are applied for the specific host set type.
|
||||
// The attributes that are applicable for the specific Host Set type.
|
||||
google.protobuf.Struct attributes = 110;
|
||||
}
|
||||
@@ -10,98 +10,76 @@ import "controller/api/resources/scopes/v1/scope.proto";
|
||||
import "controller/custom_options/v1/options.proto";
|
||||
|
||||
message Principal {
|
||||
// The ID of the principal.
|
||||
// Output only.
|
||||
// Output only. The ID of the principal.
|
||||
string id = 1;
|
||||
|
||||
// The type of the principal.
|
||||
// Output only.
|
||||
// Output only. The type of the principal.
|
||||
string type = 2;
|
||||
|
||||
// The scope ID of the principal.
|
||||
// Output only.
|
||||
// Output only. The Scope of the principal.
|
||||
string scope_id = 3 [json_name="scope_id"];
|
||||
}
|
||||
|
||||
message GrantJson {
|
||||
// The ID, if set.
|
||||
// Output only.
|
||||
// Output only. The ID, if set.
|
||||
string id = 1;
|
||||
|
||||
// The type, if set.
|
||||
// Output only.
|
||||
// Output only. The type, if set.
|
||||
string type = 2;
|
||||
|
||||
// The actions.
|
||||
// Output only.
|
||||
// Output only. The actions.
|
||||
repeated string actions = 3;
|
||||
}
|
||||
|
||||
message Grant {
|
||||
// The original user-supplied string.
|
||||
// Output only.
|
||||
// Output only. The original user-supplied string.
|
||||
string raw = 1;
|
||||
|
||||
// The canonically formatted string.
|
||||
// Output only.
|
||||
// Output only. The canonically-formatted string.
|
||||
string canonical = 2;
|
||||
|
||||
// The JSON representation of the grant.
|
||||
// Output only.
|
||||
// Output only. The JSON representation of the grant.
|
||||
GrantJson json = 3;
|
||||
}
|
||||
|
||||
// Role contains all fields related to a Role resource
|
||||
message Role {
|
||||
// The ID of the Role
|
||||
// Output only.
|
||||
// Output only. The ID of the Role
|
||||
string id = 10;
|
||||
|
||||
// The id of the scope this resource is in.
|
||||
// The ID of the Scope containing this Role.
|
||||
string scope_id = 20 [json_name="scope_id"];
|
||||
|
||||
// Scope information for this resource
|
||||
// Output only.
|
||||
// Output only. Scope information for this resource.
|
||||
resources.scopes.v1.ScopeInfo scope = 30;
|
||||
|
||||
// Optional name for identification purposes
|
||||
// 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"}];
|
||||
|
||||
// Optional user-set description for identification purposes
|
||||
// Optional user-set description for identification purposes.
|
||||
google.protobuf.StringValue description = 50 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"description" that: "description"}];
|
||||
|
||||
// The time this resource was created
|
||||
// Output only.
|
||||
// Output only. The time this resource was created.
|
||||
google.protobuf.Timestamp created_time = 60 [json_name="created_time"];
|
||||
|
||||
// The time this resource was last updated.
|
||||
// Output only.
|
||||
// Output only. The time this resource was last updated.
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name="updated_time"];
|
||||
|
||||
// The version can be used in subsequent write requests to ensure this resource
|
||||
// has not changed and to fail the write if it has.
|
||||
// Version can be used in subsequent write requests to ensure this resource has not changed and to fail the write if it has.
|
||||
uint32 version = 80;
|
||||
|
||||
// The scope the grants will apply to. If the role is at the global scope,
|
||||
// this can be an org or project. If the role is at an org
|
||||
// scope, this can be a project within the org. It is invalid for
|
||||
// this to be anything other than the role's scope when the role's scope is
|
||||
// a project.
|
||||
// The Scope the grants will apply to. If the Role is at the global scope, this can be an org or project. If the Role is at an org scope, this can be a project within the org. It is invalid for this to be anything other than the Role's scope when the Role's scope is a project.
|
||||
google.protobuf.StringValue grant_scope_id = 90 [json_name="grant_scope_id", (custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"grant_scope_id" that: "GrantScopeId"}];
|
||||
|
||||
// The IDs (only) of principals that are assigned to this role.
|
||||
// Output only.
|
||||
// Output only. The IDs (only) of principals that are assigned to this role.
|
||||
repeated string principal_ids = 100 [json_name="principal_ids"];
|
||||
|
||||
// The principals that are assigned to this role.
|
||||
// Output only.
|
||||
// Output only. The principals that are assigned to this role.
|
||||
repeated Principal principals = 110;
|
||||
|
||||
// The grants that this role provides for its principals.
|
||||
// Output only.
|
||||
// Output only. The grants that this role provides for its principals.
|
||||
repeated string grant_strings = 120 [json_name="grant_strings"];
|
||||
|
||||
// The parsed grant information.
|
||||
// Output only.
|
||||
// Output only. The parsed grant information.
|
||||
repeated Grant grants = 130;
|
||||
}
|
||||
@@ -9,59 +9,48 @@ import "google/protobuf/wrappers.proto";
|
||||
import "controller/custom_options/v1/options.proto";
|
||||
|
||||
message ScopeInfo {
|
||||
// The ID of the Scope
|
||||
// Output only.
|
||||
// Output only. The ID of the Scope.
|
||||
string id = 1;
|
||||
|
||||
// The type of the Scope
|
||||
// Output only.
|
||||
// Output only. The type of the Scope.
|
||||
string type = 2;
|
||||
|
||||
// The name of the scope, if any
|
||||
// Output only.
|
||||
// Output only. The name of the Scope, if any.
|
||||
string name = 3;
|
||||
|
||||
// The description of the scope, if any
|
||||
// Output only.
|
||||
// Output only. The description of the Scope, if any.
|
||||
string description = 4;
|
||||
|
||||
// The ID of the parent scope, if any
|
||||
// Output only.
|
||||
// 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"];
|
||||
}
|
||||
|
||||
// Scope contains all fields related to a Scope resource
|
||||
message Scope {
|
||||
// The ID of the Scope
|
||||
// Output only.
|
||||
// Output only. The ID of the Scope.
|
||||
string id = 10;
|
||||
|
||||
// The id of the scope this resource is in.
|
||||
// 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"];
|
||||
|
||||
// Scope information for this resource
|
||||
// Output only.
|
||||
// Output only. Scope information for this resource.
|
||||
ScopeInfo scope = 30;
|
||||
|
||||
// Optional name for identification purposes
|
||||
// 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"}];
|
||||
|
||||
// Optional user-set descripton for identification purposes
|
||||
// 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"}];
|
||||
|
||||
// The time this resource was created
|
||||
// Output only.
|
||||
// Output only. The time this resource was created.
|
||||
google.protobuf.Timestamp created_time = 60 [json_name="created_time"];
|
||||
|
||||
// The time this resource was last updated.
|
||||
// Output only.
|
||||
// Output only. The time this resource was last updated.
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name="updated_time"];
|
||||
|
||||
// The version can be used in subsequent write requests to ensure this
|
||||
// resource has not changed and to fail the write if it has.
|
||||
// Output only.
|
||||
// Version can be used in subsequent write requests to ensure this resource has not changed and to fail the write if it has.
|
||||
uint32 version = 80;
|
||||
|
||||
// The type of the resource
|
||||
// The type of the resource.
|
||||
string type = 90;
|
||||
}
|
||||
@@ -12,91 +12,74 @@ import "controller/api/resources/targets/v1/target.proto";
|
||||
import "controller/custom_options/v1/options.proto";
|
||||
|
||||
message WorkerInfo {
|
||||
// The address of the worker
|
||||
// The address of the worker.
|
||||
string address = 10;
|
||||
}
|
||||
|
||||
message SessionState {
|
||||
// This is the status of the session. For example "pending", "active",
|
||||
// "canceling", "terminated".
|
||||
// The status of the Session, e.g. "pending", "active", "canceling", "terminated".
|
||||
string status = 10;
|
||||
|
||||
// The time the session entered this state.
|
||||
// Output only.
|
||||
// Output only. The time the Session entered this state.
|
||||
google.protobuf.Timestamp start_time = 20 [json_name = "start_time"];
|
||||
|
||||
// The time the session stopped being in this state.
|
||||
// Output only.
|
||||
// Output only. The time the Session stopped being in this state.
|
||||
google.protobuf.Timestamp end_time = 30 [json_name = "end_time"];
|
||||
}
|
||||
|
||||
// Session contains all fields related to a Session resource
|
||||
message Session {
|
||||
// The ID of the resource
|
||||
// Output only.
|
||||
// Output only. The ID of the Session.
|
||||
string id = 10;
|
||||
|
||||
// The id of the parent of this resource. This must be defined for creation
|
||||
// of this resource, but is otherwise read only.
|
||||
// Output only. The ID of the Target that created this Session.
|
||||
string target_id = 20 [json_name = "target_id"];
|
||||
|
||||
// Scope information for this resource
|
||||
// Output only.
|
||||
// Output only. Scope information for this resource.
|
||||
resources.scopes.v1.ScopeInfo scope = 30;
|
||||
|
||||
// The time this resource was created
|
||||
// Output only.
|
||||
google.protobuf.Timestamp created_time = 40 [json_name = "created_time"];
|
||||
// Output only. The time this resource was created.
|
||||
google.protobuf.Timestamp created_time = 60 [json_name = "created_time"];
|
||||
|
||||
// The time this resource was last updated.
|
||||
// Output only.
|
||||
google.protobuf.Timestamp updated_time = 50 [json_name = "updated_time"];
|
||||
// Output only. The time this resource was last updated.
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name = "updated_time"];
|
||||
|
||||
// After this time the connection will be expired, e.g. forcefully terminated
|
||||
google.protobuf.Timestamp expiration_time = 60
|
||||
[json_name = "expiration_time"];
|
||||
// Version is used when canceling this Session to ensure that the operation is acting on a known session state.
|
||||
uint32 version = 80;
|
||||
|
||||
// The version can be used in subsequent write requests to ensure this
|
||||
// resource has not changed and to fail the write if it has.
|
||||
uint32 version = 70;
|
||||
// Output only. Type of the Session (e.g. tcp).
|
||||
string type = 90;
|
||||
|
||||
// Type of the session (e.g. tcp, ssh, etc.)
|
||||
string type = 80;
|
||||
// Output only. After this time the connection will be expired, e.g. forcefully terminated.
|
||||
google.protobuf.Timestamp expiration_time = 100 [json_name = "expiration_time"];
|
||||
|
||||
// Output only. The ID of the Auth Token used to authenticate.
|
||||
string auth_token_id = 110 [json_name = "auth_token_id"];
|
||||
|
||||
// The id of the token used to authenticate.
|
||||
string auth_token_id = 90 [json_name = "auth_token_id"];
|
||||
// Output only. The ID of the User that requested the Session.
|
||||
string user_id = 120 [json_name = "user_id"];
|
||||
|
||||
// The ID of the user that requested the session
|
||||
string user_id = 100 [json_name = "user_id"];
|
||||
// Output only. The Host Set sourcing the Host for this Session.
|
||||
string host_set_id = 130 [json_name = "host_set_id"];
|
||||
|
||||
// The host set id used by the session's target
|
||||
string host_set_id = 110 [json_name = "host_set_id"];
|
||||
// Output only. The Host used by the Session.
|
||||
string host_id = 140 [json_name = "host_id"];
|
||||
|
||||
// The host id used by the session
|
||||
string host_id = 120 [json_name = "host_id"];
|
||||
// Output only. The Scope of the Session.
|
||||
string scope_id = 150 [json_name = "scope_id"];
|
||||
|
||||
// The scope of the session
|
||||
string scope_id = 130 [json_name = "scope_id"];
|
||||
// Output only. The endpoint of the Session; that is, the address to which the worker is proxying data.
|
||||
string endpoint = 160;
|
||||
|
||||
// The endpoint of the session
|
||||
string endpoint = 140;
|
||||
// Output only. The states of this Session in descending order from the current state to the first.
|
||||
repeated SessionState states = 170;
|
||||
|
||||
// The states of this session in descending from the current state to the
|
||||
// first.
|
||||
repeated SessionState states = 150;
|
||||
// Output only. The current status of this Session.
|
||||
string status = 180;
|
||||
|
||||
// The name of the current status of this session.
|
||||
string status = 160;
|
||||
// Output only. Worker information given to the client.
|
||||
repeated WorkerInfo worker_info = 190 [json_name = "worker_info"];
|
||||
|
||||
// Worker information. The first worker in the slice should be prioritized.
|
||||
repeated WorkerInfo worker_info = 170 [json_name = "worker_info"];
|
||||
|
||||
// Deprecated, to be moved to another proto by another PR:
|
||||
// The certificate to use when connecting (or if using custom certs, to
|
||||
// serve as the "login"). Raw DER bytes.
|
||||
bytes certificate = 220;
|
||||
|
||||
// The private key to use when connecting (or if using custom certs, to pass
|
||||
// as the "password").
|
||||
bytes private_key = 230 [json_name = "private_key"];
|
||||
// Output only. The certificate generated for the session. Raw DER bytes.
|
||||
bytes certificate = 200;
|
||||
}
|
||||
@@ -11,155 +11,126 @@ import "controller/api/resources/scopes/v1/scope.proto";
|
||||
import "controller/custom_options/v1/options.proto";
|
||||
|
||||
message HostSet{
|
||||
// Output only. The ID of the Host Set.
|
||||
string id = 10;
|
||||
string host_catalog_id = 20;
|
||||
|
||||
// Output only. The Host Catalog to which this Host Set belongs.
|
||||
string host_catalog_id = 20 [json_name="host_catalog_id"];
|
||||
}
|
||||
|
||||
// Target contains all fields related to a Target resource
|
||||
message Target {
|
||||
// The ID of the resource
|
||||
// Output only.
|
||||
// Output only. The ID of the resource.
|
||||
string id = 10;
|
||||
|
||||
// The id of the parent of this resource. This must be defined for creation of this resource, but is otherwise
|
||||
// read only.
|
||||
// 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"];
|
||||
|
||||
// Scope information for this resource
|
||||
// Output only.
|
||||
// Output only. Scope information for this resource.
|
||||
resources.scopes.v1.ScopeInfo scope = 30;
|
||||
|
||||
// Required name for identification purposes
|
||||
// Required 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"}];
|
||||
|
||||
// Optional user-set description for identification purposes
|
||||
// Optional user-set description for identification purposes.
|
||||
google.protobuf.StringValue description = 50 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"description" that: "description"}];
|
||||
|
||||
// The time this resource was created
|
||||
// Output only.
|
||||
// Output only. The time this resource was created.
|
||||
google.protobuf.Timestamp created_time = 60 [json_name="created_time"];
|
||||
|
||||
// The time this resource was last updated.
|
||||
// Output only.
|
||||
// Output only. The time this resource was last updated.
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name="updated_time"];
|
||||
|
||||
// The version can be used in subsequent write requests to ensure this
|
||||
// resource has not changed and to fail the write if it has.
|
||||
// Version can be used in subsequent write requests to ensure this resource has not changed and to fail the write if it has.
|
||||
uint32 version = 80;
|
||||
|
||||
// The type of the Target.
|
||||
string type = 90;
|
||||
|
||||
// The ids of the host sets that make up this target.
|
||||
repeated string host_set_ids = 100;
|
||||
// The IDs of the Host Sets associated with this Target.
|
||||
repeated string host_set_ids = 100 [json_name="host_set_ids"];
|
||||
|
||||
// The host sets that make up this target.
|
||||
// Output only.
|
||||
repeated HostSet host_sets = 110;
|
||||
// Output only. The Host Sets associated with this Target.
|
||||
repeated HostSet host_sets = 110 [json_name="host_sets"];
|
||||
|
||||
// Maximum total lifetime of a created session, in seconds
|
||||
google.protobuf.UInt32Value session_max_seconds = 120 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"session_max_seconds" that: "SessionMaxSeconds"}];
|
||||
// Maximum total lifetime of a created Session, in seconds.
|
||||
google.protobuf.UInt32Value session_max_seconds = 120 [json_name="session_max_seconds", (custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"session_max_seconds" that: "SessionMaxSeconds"}];
|
||||
|
||||
// Maximum number of connections in a session
|
||||
google.protobuf.Int32Value session_connection_limit = 130 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"session_connection_limit" that: "SessionConnectionLimit"}];
|
||||
// Maximum number of connections allowed in a Session.
|
||||
google.protobuf.Int32Value session_connection_limit = 130 [json_name="session_connection_limit", (custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"session_connection_limit" that: "SessionConnectionLimit"}];
|
||||
|
||||
// The attributes that are applied for the specific Target type.
|
||||
// The attributes that are applicable for the specific Target.
|
||||
google.protobuf.Struct attributes = 200 [(custom_options.v1.generate_sdk_option) = true];
|
||||
}
|
||||
|
||||
// TcpTargetAttributes contains attributes relevant to Targets of type "tcp"
|
||||
message TcpTargetAttributes {
|
||||
google.protobuf.UInt32Value default_port = 10 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"attributes.default_port" that: "DefaultPort"}];
|
||||
// The default TCP port that will be used when connecting to the endpoint unless overridden by a Host Set or Host.
|
||||
google.protobuf.UInt32Value default_port = 10 [json_name="default_port", (custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"attributes.default_port" that: "DefaultPort"}];
|
||||
}
|
||||
|
||||
// WorkerInfo contains information about workers, returned in
|
||||
// SessionAuthorization
|
||||
// WorkerInfo contains information about workers, returned in to the client in SessionAuthorization
|
||||
message WorkerInfo {
|
||||
// The address of the worker
|
||||
// Output only. The address of the worker.
|
||||
string address = 10;
|
||||
}
|
||||
|
||||
// SessionAuthorization contains all fields related to authorization for a
|
||||
// session. It's in the Targets API because it's returned by a target authorize
|
||||
// action.
|
||||
// SessionAuthorizationData contains the fields needed by the proxy command to connect to a worker. It is marshaled inside the SessionAuthorization message.
|
||||
message SessionAuthorizationData {
|
||||
// The ID of the session
|
||||
// Output only.
|
||||
string session_id = 10;
|
||||
// Output only. The ID of the session.
|
||||
string session_id = 10 [json_name="session_id"];
|
||||
|
||||
// The id of the target authorizing this session. This must be defined for
|
||||
// creation of this resource, but is otherwise read only.
|
||||
// Output only.
|
||||
// Output only. The ID of the Target authorizing this session.
|
||||
string target_id = 20 [json_name="target_id"];
|
||||
|
||||
// Scope information for this resource
|
||||
// Output only.
|
||||
// Output only. Scope information for this the Target that authorized this session.
|
||||
resources.scopes.v1.ScopeInfo scope = 30;
|
||||
|
||||
// The time this resource was created
|
||||
// Output only.
|
||||
// Output only. The time this resource was created.
|
||||
google.protobuf.Timestamp created_time = 40 [json_name="created_time"];
|
||||
|
||||
// Type of the session (e.g. tcp, ssh, etc.)
|
||||
// Output only.
|
||||
// Output only. Type of the session (e.g. tcp, ssh, etc.).
|
||||
string type = 80;
|
||||
|
||||
// Connection limit. -1 means unlimited. This is not actually enforced on
|
||||
// the client side but it provides for better listener handling by including
|
||||
// it.
|
||||
// Output only.
|
||||
int32 connection_limit = 90;
|
||||
// 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"];
|
||||
|
||||
// The certificate to use when connecting (or if using custom certs, to
|
||||
// serve as the "login"). Raw DER bytes.
|
||||
// Output only.
|
||||
// Output only. The certificate to use when connecting. Raw DER bytes.
|
||||
bytes certificate = 120;
|
||||
|
||||
// The private key to use when connecting (or if using custom certs, to pass
|
||||
// as the "password"). We are using Ed25519 so this is purely raw bytes, no
|
||||
// marshaling.
|
||||
// Output only.
|
||||
// Output only. The private key to use when connecting. We are using Ed25519, so this is purely raw bytes, no marshaling.
|
||||
bytes private_key = 130 [json_name="private_key"];
|
||||
|
||||
// Worker information. The first worker in the array should be prioritized.
|
||||
// Output only.
|
||||
// Output only. Worker information. The first worker in the array should be prioritized.
|
||||
repeated WorkerInfo worker_info = 150 [json_name="worker_info"];
|
||||
}
|
||||
|
||||
// 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 {
|
||||
// The ID of the session
|
||||
// Output only.
|
||||
string session_id = 10;
|
||||
// Output only. The ID of the Session.
|
||||
string session_id = 10 [json_name="session_id"];
|
||||
|
||||
// The id of the target authorizing this session. This must be defined for
|
||||
// creation of this resource, but is otherwise read only.
|
||||
// Output only.
|
||||
// Output only. The ID of the Target authorizing this Session.
|
||||
string target_id = 20 [json_name="target_id"];
|
||||
|
||||
// Scope information for this resource
|
||||
// Output only.
|
||||
// Output only. Scope information for this resource.
|
||||
resources.scopes.v1.ScopeInfo scope = 30;
|
||||
|
||||
// The time this resource was created
|
||||
// Output only.
|
||||
// Output only. The time this resource was created.
|
||||
google.protobuf.Timestamp created_time = 40 [json_name="created_time"];
|
||||
|
||||
// The user ID associated with the resource
|
||||
// Output only.
|
||||
string user_id = 50;
|
||||
// Output only. The User for which this Session was authorized.
|
||||
string user_id = 50 [json_name="user_id"];
|
||||
|
||||
// The host set ID associated with the resource
|
||||
// Output only.
|
||||
string host_set_id = 60;
|
||||
// Output only. The Host Set containing the Host being used for this Session.
|
||||
string host_set_id = 60 [json_name="host_set_id"];
|
||||
|
||||
// The host ID associated with the resource.
|
||||
// Output only.
|
||||
string host_id = 70;
|
||||
// Output only. The Host whose address is being used as the endpoint for this Session.
|
||||
string host_id = 70 [json_name="host_id"];
|
||||
|
||||
// Type of the session (e.g. tcp, ssh, etc.)
|
||||
// Output only.
|
||||
// Output only. Type of the Session (e.g. tcp, ssh, etc.).
|
||||
string type = 80;
|
||||
|
||||
// The marshaled SessionAuthorizationData message containing all information
|
||||
// that the proxy needs.
|
||||
// Output only.
|
||||
string authorization_token = 90;
|
||||
// Output only. The marshaled SessionAuthorizationData message containing all information that the proxy needs.
|
||||
string authorization_token = 90 [json_name="authorization_token"];
|
||||
}
|
||||
@@ -10,51 +10,42 @@ import "controller/api/resources/scopes/v1/scope.proto";
|
||||
import "controller/custom_options/v1/options.proto";
|
||||
|
||||
message Account {
|
||||
// The ID of the account.
|
||||
// Output only.
|
||||
// Output only. The ID of the Account.
|
||||
string id = 10;
|
||||
|
||||
// The scope ID of the account.
|
||||
// Output only.
|
||||
// Output only. The Scope containing the Account.
|
||||
string scope_id = 20 [json_name="scope_id"];
|
||||
}
|
||||
|
||||
// User contains all fields related to a User resource
|
||||
message User {
|
||||
// The ID of the Project
|
||||
// Output only.
|
||||
// Output only. The ID of the User.
|
||||
string id = 10;
|
||||
|
||||
// The id of the scope this resource is in.
|
||||
// The ID of the Scope this resource is in.
|
||||
string scope_id = 20 [json_name="scope_id"];
|
||||
|
||||
// Scope information for this resource
|
||||
// Output only.
|
||||
// Output only. Scope information for this resource.
|
||||
resources.scopes.v1.ScopeInfo scope = 30;
|
||||
|
||||
// Optional name for identification purposes
|
||||
// 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"}];
|
||||
|
||||
// Optional user-set description for identification purposes
|
||||
// Optional user-set description for identification purposes.
|
||||
google.protobuf.StringValue description = 50 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"description" that: "description"}];
|
||||
|
||||
// The time this resource was created
|
||||
// Output only.
|
||||
// Output only. The time this resource was created.
|
||||
google.protobuf.Timestamp created_time = 60 [json_name="created_time"];
|
||||
|
||||
// The time this resource was last updated.
|
||||
// Output only.
|
||||
// Output only. The time this resource was last updated.
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name="updated_time"];
|
||||
|
||||
// The version can be used in subsequent write requests to ensure this
|
||||
// resource has not changed and to fail the write if it has.
|
||||
// Version can be used in subsequent write requests to ensure this resource has not changed and to fail the write if it has.
|
||||
uint32 version = 80;
|
||||
|
||||
// Contains the list of account ids for this user.
|
||||
// Output only.
|
||||
repeated string account_ids = 90;
|
||||
// Output only. Contains the list of Account IDs linked to this User.
|
||||
repeated string account_ids = 90 [json_name="account_ids"];
|
||||
|
||||
// The acounts for this user.
|
||||
// Output only.
|
||||
// Output only. The Accounts linked to this User.
|
||||
repeated Account accounts = 100;
|
||||
}
|
||||
@@ -119,7 +119,6 @@ service AccountService {
|
||||
|
||||
message GetAccountRequest {
|
||||
string id = 1;
|
||||
string view = 2;
|
||||
}
|
||||
|
||||
message GetAccountResponse {
|
||||
@@ -127,8 +126,7 @@ message GetAccountResponse {
|
||||
}
|
||||
|
||||
message ListAccountsRequest {
|
||||
string auth_method_id = 1;
|
||||
string view = 2;
|
||||
string auth_method_id = 1 [json_name="auth_method_id"];
|
||||
}
|
||||
|
||||
message ListAccountsResponse {
|
||||
@@ -147,7 +145,7 @@ message CreateAccountResponse {
|
||||
message UpdateAccountRequest {
|
||||
string id = 1;
|
||||
resources.accounts.v1.Account item = 2;
|
||||
google.protobuf.FieldMask update_mask = 3;
|
||||
google.protobuf.FieldMask update_mask = 3 [json_name="update_mask"];
|
||||
}
|
||||
|
||||
message UpdateAccountResponse {
|
||||
|
||||
@@ -89,7 +89,6 @@ service AuthMethodService {
|
||||
|
||||
message GetAuthMethodRequest {
|
||||
string id = 1;
|
||||
string view = 2;
|
||||
}
|
||||
|
||||
message GetAuthMethodResponse {
|
||||
@@ -98,7 +97,6 @@ message GetAuthMethodResponse {
|
||||
|
||||
message ListAuthMethodsRequest {
|
||||
string scope_id = 1 [json_name="scope_id"];
|
||||
string view = 2;
|
||||
}
|
||||
|
||||
message ListAuthMethodsResponse {
|
||||
@@ -117,7 +115,7 @@ message CreateAuthMethodResponse {
|
||||
message UpdateAuthMethodRequest {
|
||||
string id = 1;
|
||||
resources.authmethods.v1.AuthMethod item = 2;
|
||||
google.protobuf.FieldMask update_mask = 3;
|
||||
google.protobuf.FieldMask update_mask = 3 [json_name="update_mask"];
|
||||
}
|
||||
|
||||
message UpdateAuthMethodResponse {
|
||||
|
||||
@@ -10,7 +10,7 @@ import "google/protobuf/struct.proto";
|
||||
import "controller/api/resources/authtokens/v1/authtoken.proto";
|
||||
|
||||
service AuthenticationService {
|
||||
// Authenticate validates credentials provided and returns an auth token.
|
||||
// Authenticate validates credentials provided and returns an Auth Token.
|
||||
rpc Authenticate(AuthenticateRequest) returns (AuthenticateResponse) {
|
||||
option (google.api.http) = {
|
||||
post: "/v1/auth-methods/{auth_method_id}:authenticate"
|
||||
@@ -21,46 +21,24 @@ service AuthenticationService {
|
||||
summary: "Authenticate a user to an scope and retrieve an authentication token."
|
||||
};
|
||||
}
|
||||
|
||||
}
|
||||
// Logout terminates a user's current session.
|
||||
// TODO: Ideally it'd live here but grpc-gateway chokes on it. But deauth should really be scopeless.
|
||||
/*
|
||||
rpc Deauthenticate(DeauthenticateRequest) returns (DeauthenticateResponse) {
|
||||
option (google.api.http) = {
|
||||
post: "/v1/:deauthenticate"
|
||||
};
|
||||
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
||||
summary: "Deauthenticate an authentication token."
|
||||
};
|
||||
}
|
||||
}
|
||||
*/
|
||||
|
||||
// The layout of the struct for "credentials" field in AuthenticateRequest. This message isn't
|
||||
// directly referenced anywhere but is used here to define the expected field names and types.
|
||||
// The layout of the struct for "credentials" field in AuthenticateRequest. This message isn't directly referenced anywhere but is used here to define the expected field names and types.
|
||||
message PasswordCredentials {
|
||||
string login_name = 1;
|
||||
string login_name = 1 [json_name="login_name"];
|
||||
string password = 2;
|
||||
}
|
||||
|
||||
message AuthenticateRequest {
|
||||
// The id to the authmethod in the system being used for authentication. The auth method must be in the scope
|
||||
// being logged in to.
|
||||
string auth_method_id = 1;
|
||||
// This can be "cookie" or "token". If not provided, "token" will be used.
|
||||
string token_type = 2;
|
||||
|
||||
// credentials are the different possible credential names depending on what type of auth method is used.
|
||||
// For password auth method: should include only "name" and "password".
|
||||
// The ID of the Auth Method in the system that should be used for authentication.
|
||||
string auth_method_id = 1 [json_name="auth_method_id"];
|
||||
// This can be "cookie" or "token". If not provided, "token" will be used. "cookie" activates a split-cookie method where the token is split partially between http-only and regular cookies in order to keep it safe from rogue JS in the browser.
|
||||
string token_type = 2 [json_name="token_type"];
|
||||
// Credentials are passed to the Auth Method; the valid keys and values depend on the type of Auth Method.
|
||||
google.protobuf.Struct credentials = 3;
|
||||
}
|
||||
|
||||
message AuthenticateResponse {
|
||||
resources.authtokens.v1.AuthToken item = 1;
|
||||
// This can be "cookie" or "token". If not present, "token" should be assumed.
|
||||
string token_type = 2;
|
||||
}
|
||||
|
||||
message DeauthenticateRequest {}
|
||||
message DeauthenticateResponse {}
|
||||
string token_type = 2 [json_name="token_type"];
|
||||
}
|
||||
@@ -54,7 +54,6 @@ service AuthTokenService {
|
||||
|
||||
message GetAuthTokenRequest {
|
||||
string id = 1;
|
||||
string view = 2;
|
||||
}
|
||||
|
||||
message GetAuthTokenResponse {
|
||||
@@ -63,7 +62,6 @@ message GetAuthTokenResponse {
|
||||
|
||||
message ListAuthTokensRequest {
|
||||
string scope_id = 1 [json_name="scope_id"];
|
||||
string view = 2;
|
||||
}
|
||||
|
||||
message ListAuthTokensResponse {
|
||||
|
||||
@@ -138,7 +138,6 @@ service GroupService {
|
||||
|
||||
message GetGroupRequest {
|
||||
string id = 1;
|
||||
string view = 2;
|
||||
}
|
||||
|
||||
message GetGroupResponse {
|
||||
@@ -146,8 +145,7 @@ message GetGroupResponse {
|
||||
}
|
||||
|
||||
message ListGroupsRequest {
|
||||
string scope_id = 1;
|
||||
string view = 2;
|
||||
string scope_id = 1 [json_name="scope_id"];
|
||||
}
|
||||
|
||||
message ListGroupsResponse {
|
||||
@@ -166,7 +164,7 @@ message CreateGroupResponse {
|
||||
message UpdateGroupRequest {
|
||||
string id = 1;
|
||||
resources.groups.v1.Group item = 2;
|
||||
google.protobuf.FieldMask update_mask = 3;
|
||||
google.protobuf.FieldMask update_mask = 3 [json_name="update_mask"];
|
||||
}
|
||||
|
||||
message UpdateGroupResponse {
|
||||
@@ -181,8 +179,7 @@ message DeleteGroupResponse {}
|
||||
|
||||
message AddGroupMembersRequest {
|
||||
string id = 1;
|
||||
// The version ensures the group hasn't changed since it was last retrieved and if
|
||||
// it has the request will fail.
|
||||
// The version ensures the group hasn't changed since it was last retrieved and if it has the request will fail.
|
||||
uint32 version = 2;
|
||||
repeated string member_ids = 3 [json_name="member_ids"];
|
||||
}
|
||||
@@ -193,8 +190,7 @@ message AddGroupMembersResponse {
|
||||
|
||||
message SetGroupMembersRequest {
|
||||
string id = 1;
|
||||
// The version ensures the group hasn't changed since it was last retrieved and if
|
||||
// it has the request will fail.
|
||||
// The version ensures the group hasn't changed since it was last retrieved and if it has the request will fail.
|
||||
uint32 version = 2;
|
||||
repeated string member_ids = 3 [json_name="member_ids"];
|
||||
}
|
||||
@@ -205,8 +201,7 @@ message SetGroupMembersResponse {
|
||||
|
||||
message RemoveGroupMembersRequest {
|
||||
string id = 1;
|
||||
// The version ensures the group hasn't changed since it was last retrieved and if
|
||||
// it has the request will fail.
|
||||
// The version ensures the group hasn't changed since it was last retrieved and if it has the request will fail.
|
||||
uint32 version = 2;
|
||||
repeated string member_ids = 3 [json_name="member_ids"];
|
||||
}
|
||||
|
||||
@@ -94,7 +94,6 @@ service HostCatalogService {
|
||||
|
||||
message GetHostCatalogRequest {
|
||||
string id = 1;
|
||||
string view = 2;
|
||||
}
|
||||
|
||||
message GetHostCatalogResponse {
|
||||
@@ -103,7 +102,6 @@ message GetHostCatalogResponse {
|
||||
|
||||
message ListHostCatalogsRequest {
|
||||
string scope_id = 1 [json_name="scope_id"];
|
||||
string view = 2;
|
||||
}
|
||||
|
||||
message ListHostCatalogsResponse {
|
||||
|
||||
@@ -90,7 +90,6 @@ service HostService {
|
||||
|
||||
message GetHostRequest {
|
||||
string id = 1;
|
||||
string view = 2;
|
||||
}
|
||||
|
||||
message GetHostResponse {
|
||||
@@ -99,7 +98,6 @@ message GetHostResponse {
|
||||
|
||||
message ListHostsRequest {
|
||||
string host_catalog_id = 1 [json_name="host_catalog_id"];
|
||||
string view = 2;
|
||||
}
|
||||
|
||||
message ListHostsResponse {
|
||||
@@ -118,7 +116,7 @@ message CreateHostResponse {
|
||||
message UpdateHostRequest {
|
||||
string id = 1;
|
||||
api.resources.hosts.v1.Host item = 2;
|
||||
google.protobuf.FieldMask update_mask = 3;
|
||||
google.protobuf.FieldMask update_mask = 3 [json_name="update_mask"];
|
||||
}
|
||||
|
||||
message UpdateHostResponse {
|
||||
|
||||
@@ -152,7 +152,6 @@ service HostSetService {
|
||||
|
||||
message GetHostSetRequest {
|
||||
string id = 1;
|
||||
string view = 2;
|
||||
}
|
||||
|
||||
message GetHostSetResponse {
|
||||
@@ -161,7 +160,6 @@ message GetHostSetResponse {
|
||||
|
||||
message ListHostSetsRequest {
|
||||
string host_catalog_id = 1 [json_name="host_catalog_id"];
|
||||
string view = 2;
|
||||
}
|
||||
|
||||
message ListHostSetsResponse {
|
||||
@@ -180,7 +178,7 @@ message CreateHostSetResponse {
|
||||
message UpdateHostSetRequest {
|
||||
string id = 1;
|
||||
api.resources.hostsets.v1.HostSet item = 2;
|
||||
google.protobuf.FieldMask update_mask = 3;
|
||||
google.protobuf.FieldMask update_mask = 3 [json_name="update_mask"];
|
||||
}
|
||||
|
||||
message UpdateHostSetResponse {
|
||||
@@ -197,10 +195,8 @@ message AddHostSetHostsRequest {
|
||||
string id = 1;
|
||||
uint32 version = 2;
|
||||
|
||||
// A list of host IDs which will be added to this host set. Each host
|
||||
// referenced here must be a child of the same host catalog that this host
|
||||
// set is a child of.
|
||||
repeated string host_ids = 3;
|
||||
// A list of Host IDs which will be added to this Host Set. Each Host referenced here must be a child of the same Host Catalog of which this Host Set is a child.
|
||||
repeated string host_ids = 3 [json_name="host_ids"];
|
||||
}
|
||||
|
||||
message AddHostSetHostsResponse {
|
||||
@@ -211,10 +207,8 @@ message SetHostSetHostsRequest {
|
||||
string id = 1;
|
||||
uint32 version = 2;
|
||||
|
||||
// A list of host IDs which will be set on this host set. Each host
|
||||
// referenced here must be a child of the same host catalog that this host
|
||||
// set is a child of.
|
||||
repeated string host_ids = 3;
|
||||
// A list of Host IDs which will be set on this Host Set. Each Host referenced here must be a child of the same Host Catalog of which this Host Set is a child.
|
||||
repeated string host_ids = 3 [json_name="host_ids"];
|
||||
}
|
||||
|
||||
message SetHostSetHostsResponse {
|
||||
@@ -222,13 +216,11 @@ message SetHostSetHostsResponse {
|
||||
}
|
||||
|
||||
message RemoveHostSetHostsRequest {
|
||||
// This host set's id.
|
||||
string id = 1;
|
||||
uint32 version = 2;
|
||||
|
||||
// A list of host IDs which should not be in the host set when this request
|
||||
// returns.
|
||||
repeated string host_ids = 3;
|
||||
// A list of Host IDs which will be removed from this Host Set.
|
||||
repeated string host_ids = 3 [json_name="host_ids"];
|
||||
}
|
||||
|
||||
message RemoveHostSetHostsResponse {
|
||||
|
||||
@@ -186,7 +186,6 @@ service RoleService {
|
||||
|
||||
message GetRoleRequest {
|
||||
string id = 1;
|
||||
string view = 2;
|
||||
}
|
||||
|
||||
message GetRoleResponse {
|
||||
@@ -195,7 +194,6 @@ message GetRoleResponse {
|
||||
|
||||
message ListRolesRequest {
|
||||
string scope_id = 1 [json_name="scope_id"];
|
||||
string view = 2;
|
||||
}
|
||||
|
||||
message ListRolesResponse {
|
||||
@@ -211,11 +209,10 @@ message CreateRoleResponse {
|
||||
resources.roles.v1.Role item = 2;
|
||||
}
|
||||
|
||||
// TODO: Add versions to Update and Delete role requests.
|
||||
message UpdateRoleRequest {
|
||||
string id = 1;
|
||||
resources.roles.v1.Role item = 2;
|
||||
google.protobuf.FieldMask update_mask = 3;
|
||||
google.protobuf.FieldMask update_mask = 3 [json_name="update_mask"];
|
||||
}
|
||||
|
||||
message UpdateRoleResponse {
|
||||
@@ -230,8 +227,7 @@ message DeleteRoleResponse {}
|
||||
|
||||
message AddRolePrincipalsRequest {
|
||||
string id = 1;
|
||||
// The version ensures the role hasn't changed since it was last retrieved and if
|
||||
// it has the request will fail.
|
||||
// The version ensures the role hasn't changed since it was last retrieved and if it has the request will fail.
|
||||
uint32 version = 2;
|
||||
repeated string principal_ids = 3 [json_name="principal_ids"];
|
||||
}
|
||||
@@ -242,8 +238,7 @@ message AddRolePrincipalsResponse {
|
||||
|
||||
message SetRolePrincipalsRequest {
|
||||
string id = 1;
|
||||
// The version ensures the role hasn't changed since it was last retrieved and if
|
||||
// it has the request will fail.
|
||||
// The version ensures the role hasn't changed since it was last retrieved and if it has the request will fail.
|
||||
uint32 version = 2;
|
||||
repeated string principal_ids = 3 [json_name="principal_ids"];
|
||||
}
|
||||
@@ -254,8 +249,7 @@ message SetRolePrincipalsResponse {
|
||||
|
||||
message RemoveRolePrincipalsRequest {
|
||||
string id = 1;
|
||||
// The version ensures the role hasn't changed since it was last retrieved and if
|
||||
// it has the request will fail.
|
||||
// The version ensures the role hasn't changed since it was last retrieved and if it has the request will fail.
|
||||
uint32 version = 2;
|
||||
repeated string principal_ids = 3 [json_name="principal_ids"];
|
||||
}
|
||||
@@ -266,8 +260,7 @@ message RemoveRolePrincipalsResponse {
|
||||
|
||||
message AddRoleGrantsRequest {
|
||||
string id = 1;
|
||||
// The version ensures the role hasn't changed since it was last retrieved and if
|
||||
// it has the request will fail.
|
||||
// The version ensures the role hasn't changed since it was last retrieved and if it has the request will fail.
|
||||
uint32 version = 2;
|
||||
repeated string grant_strings = 3 [json_name="grant_strings"];
|
||||
}
|
||||
@@ -278,8 +271,7 @@ message AddRoleGrantsResponse {
|
||||
|
||||
message SetRoleGrantsRequest {
|
||||
string id = 1;
|
||||
// The version ensures the role hasn't changed since it was last retrieved and if
|
||||
// it has the request will fail.
|
||||
// The version ensures the role hasn't changed since it was last retrieved and if it has the request will fail.
|
||||
uint32 version = 2;
|
||||
repeated string grant_strings = 3 [json_name="grant_strings"];
|
||||
}
|
||||
@@ -290,8 +282,7 @@ message SetRoleGrantsResponse {
|
||||
|
||||
message RemoveRoleGrantsRequest {
|
||||
string id = 1;
|
||||
// The version ensures the role hasn't changed since it was last retrieved and if
|
||||
// it has the request will fail.
|
||||
// The version ensures the role hasn't changed since it was last retrieved and if it has the request will fail.
|
||||
uint32 version = 2;
|
||||
repeated string grant_strings = 3 [json_name="grant_strings"];
|
||||
}
|
||||
|
||||
@@ -88,7 +88,6 @@ service ScopeService {
|
||||
|
||||
message GetScopeRequest {
|
||||
string id = 1;
|
||||
string view = 2;
|
||||
}
|
||||
|
||||
message GetScopeResponse {
|
||||
@@ -97,7 +96,6 @@ message GetScopeResponse {
|
||||
|
||||
message ListScopesRequest {
|
||||
string scope_id = 1;
|
||||
string view = 2;
|
||||
}
|
||||
|
||||
message ListScopesResponse {
|
||||
@@ -117,7 +115,7 @@ message CreateScopeResponse {
|
||||
message UpdateScopeRequest {
|
||||
string id = 1;
|
||||
resources.scopes.v1.Scope item = 2;
|
||||
google.protobuf.FieldMask update_mask = 3;
|
||||
google.protobuf.FieldMask update_mask = 3 [json_name="update_mask"];
|
||||
}
|
||||
|
||||
message UpdateScopeResponse {
|
||||
|
||||
@@ -54,7 +54,6 @@ service SessionService {
|
||||
|
||||
message GetSessionRequest {
|
||||
string id = 1;
|
||||
string view = 2;
|
||||
}
|
||||
|
||||
message GetSessionResponse {
|
||||
@@ -63,7 +62,6 @@ message GetSessionResponse {
|
||||
|
||||
message ListSessionsRequest {
|
||||
string scope_id = 1;
|
||||
string view = 2;
|
||||
}
|
||||
|
||||
message ListSessionsResponse {
|
||||
|
||||
@@ -154,7 +154,6 @@ service TargetService {
|
||||
|
||||
message GetTargetRequest {
|
||||
string id = 1;
|
||||
string view = 2;
|
||||
}
|
||||
|
||||
message GetTargetResponse {
|
||||
@@ -163,7 +162,6 @@ message GetTargetResponse {
|
||||
|
||||
message ListTargetsRequest {
|
||||
string scope_id = 1;
|
||||
string view = 2;
|
||||
}
|
||||
|
||||
message ListTargetsResponse {
|
||||
@@ -182,7 +180,7 @@ message CreateTargetResponse {
|
||||
message UpdateTargetRequest {
|
||||
string id = 1;
|
||||
resources.targets.v1.Target item = 2;
|
||||
google.protobuf.FieldMask update_mask = 3;
|
||||
google.protobuf.FieldMask update_mask = 3 [json_name="update_mask"];
|
||||
}
|
||||
|
||||
message UpdateTargetResponse {
|
||||
@@ -199,10 +197,8 @@ message AddTargetHostSetsRequest {
|
||||
string id = 1;
|
||||
uint32 version = 2;
|
||||
|
||||
// A list of host set IDs which will be added to this target. Each host set
|
||||
// referenced here must be a child of a host catalog in the same scope as this
|
||||
// target
|
||||
repeated string host_set_ids = 3;
|
||||
// A list of Host Set IDs which will be added to this target. Each Host Set referenced here must be a child of a Host Catalog in the same Scope as this Target.
|
||||
repeated string host_set_ids = 3 [json_name="host_set_ids"];
|
||||
}
|
||||
|
||||
message AddTargetHostSetsResponse {
|
||||
@@ -213,10 +209,8 @@ message SetTargetHostSetsRequest {
|
||||
string id = 1;
|
||||
uint32 version = 2;
|
||||
|
||||
// A list of host set IDs which will be set on this target. Each host set
|
||||
// referenced here must be a child of a host catalog in the same scope as this
|
||||
// target.
|
||||
repeated string host_set_ids = 3;
|
||||
// A list of Host Set IDs which will be set on this target. Each Host Set referenced here must be a child of a Host Catalog in the same Scope as this Target.
|
||||
repeated string host_set_ids = 3 [json_name="host_set_ids"];
|
||||
}
|
||||
|
||||
message SetTargetHostSetsResponse {
|
||||
@@ -227,9 +221,8 @@ message RemoveTargetHostSetsRequest {
|
||||
string id = 1;
|
||||
uint32 version = 2;
|
||||
|
||||
// A list of host set IDs which should not be in the target when this request
|
||||
// returns.
|
||||
repeated string host_set_ids = 3;
|
||||
// A list of Host Set IDs which will be removed from this target.
|
||||
repeated string host_set_ids = 3 [json_name="host_set_ids"];
|
||||
}
|
||||
|
||||
message RemoveTargetHostSetsResponse {
|
||||
@@ -239,9 +232,8 @@ message RemoveTargetHostSetsResponse {
|
||||
message AuthorizeSessionRequest {
|
||||
string id = 1;
|
||||
|
||||
// An optional parameter allowing specification of the particular host within
|
||||
// the target's host sets to connect to during this session.
|
||||
string host_id = 2;
|
||||
// An optional parameter allowing specification of the particular Host within the Target's configured Host Sets to connect to during this Session.
|
||||
string host_id = 2 [json_name="host_id"];
|
||||
}
|
||||
|
||||
message AuthorizeSessionResponse {
|
||||
|
||||
@@ -138,7 +138,6 @@ service UserService {
|
||||
|
||||
message GetUserRequest {
|
||||
string id = 1;
|
||||
string view = 2;
|
||||
}
|
||||
|
||||
message GetUserResponse {
|
||||
@@ -147,7 +146,6 @@ message GetUserResponse {
|
||||
|
||||
message ListUsersRequest {
|
||||
string scope_id = 1;
|
||||
string view = 2;
|
||||
}
|
||||
|
||||
message ListUsersResponse {
|
||||
@@ -166,7 +164,7 @@ message CreateUserResponse {
|
||||
message UpdateUserRequest {
|
||||
string id = 1;
|
||||
resources.users.v1.User item = 2;
|
||||
google.protobuf.FieldMask update_mask = 3;
|
||||
google.protobuf.FieldMask update_mask = 3 [json_name="update_mask"];
|
||||
}
|
||||
|
||||
message UpdateUserResponse {
|
||||
@@ -181,8 +179,7 @@ message DeleteUserResponse {}
|
||||
|
||||
message AddUserAccountsRequest {
|
||||
string id = 1;
|
||||
// The version ensures the user hasn't changed since it was last retrieved and if
|
||||
// it has the request will fail.
|
||||
// The version ensures the user hasn't changed since it was last retrieved and if it has the request will fail.
|
||||
uint32 version = 2;
|
||||
repeated string account_ids = 3 [json_name="account_ids"];
|
||||
}
|
||||
@@ -193,8 +190,7 @@ message AddUserAccountsResponse {
|
||||
|
||||
message SetUserAccountsRequest {
|
||||
string id = 1;
|
||||
// The version ensures the user hasn't changed since it was last retrieved and if
|
||||
// it has the request will fail.
|
||||
// The version ensures the user hasn't changed since it was last retrieved and if it has the request will fail.
|
||||
uint32 version = 2;
|
||||
repeated string account_ids = 3 [json_name="account_ids"];
|
||||
}
|
||||
@@ -205,8 +201,7 @@ message SetUserAccountsResponse {
|
||||
|
||||
message RemoveUserAccountsRequest {
|
||||
string id = 1;
|
||||
// The version ensures the user hasn't changed since it was last retrieved and if
|
||||
// it has the request will fail.
|
||||
// The version ensures the user hasn't changed since it was last retrieved and if it has the request will fail.
|
||||
uint32 version = 2;
|
||||
repeated string account_ids = 3 [json_name="account_ids"];
|
||||
}
|
||||
|
||||
@@ -5,27 +5,33 @@ package controller.api.v1;
|
||||
option go_package = "github.com/hashicorp/boundary/internal/gen/controller/api;api";
|
||||
|
||||
message ErrorDetails {
|
||||
// The TraceId that can be used for OpenTelemetry.
|
||||
string TraceId = 1 [json_name="TraceId"];
|
||||
// A request ID.
|
||||
string request_id = 2 [json_name="request_id"];
|
||||
// An Error ID.
|
||||
string error_id = 3 [json_name="error_id"];
|
||||
// Request-field-specific error details.
|
||||
repeated FieldError request_fields = 4 [json_name="request_fields"];
|
||||
}
|
||||
|
||||
// FieldErrors contains error information on a per field basis.
|
||||
message FieldError {
|
||||
// The name of the field.
|
||||
string name = 1;
|
||||
string description= 2;
|
||||
|
||||
// The description of the error.
|
||||
string description = 2;
|
||||
}
|
||||
|
||||
// Error is returned by the JSON API when an error occurs.
|
||||
message Error {
|
||||
// The HTTP Status code applicable to this error
|
||||
// The HTTP Status code applicable to this error.
|
||||
int32 status = 1;
|
||||
// An application-specific error string
|
||||
// An application-specific error string.
|
||||
string code = 2;
|
||||
// A human readable explanation specific to this occurrence of the error
|
||||
// A human-readable explanation specific to this occurrence of the error.
|
||||
string message = 3;
|
||||
// Additional metadata regarding the error. Depending on the error
|
||||
// different fields will be populated.
|
||||
// Additional metadata regarding the error. Depending on the error, different fields will be populated.
|
||||
ErrorDetails details = 4;
|
||||
}
|
||||
Reference in new issue
Block a user