boundary/internal/proto/local/controller/api/resources/users/v1/user.proto

syntax = "proto3";

package controller.api.resources.users.v1;

option go_package = "github.com/hashicorp/boundary/internal/gen/controller/api/resources/users;users";

import "google/protobuf/timestamp.proto";
import "google/protobuf/wrappers.proto";
import "controller/api/resources/scopes/v1/scope.proto";
import "controller/custom_options/v1/options.proto";

message Account {
	// The ID of the account.
	// Output only.
	string id = 10;

	// The scope ID of the account.
	// Output only.
	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.
	string id = 10;

	// The id of the scope this resource is in.
	string scope_id = 20 [json_name="scope_id"];

	// Scope information for this resource
	// Output only.
	resources.scopes.v1.ScopeInfo scope = 30;
	
	// Optional name for identification purposes
	google.protobuf.StringValue name = 40 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"name" that: "name"}];

	// 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.
	google.protobuf.Timestamp created_time = 60 [json_name="created_time"];

	// The time this resource was last updated.
	// Output only.
	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.
	uint32 version = 80;

	// Contains the list of account ids for this user.
	// Output only.
	repeated string account_ids = 90;

	// The acounts for this user.
	// Output only.
	repeated Account accounts = 100;
}