Jeff Mitchell
b13975cb6a
This moves the generated pb files to the `sdk` module. This allows third parties to make use of them if desired (e.g. in upcoming plugins) and moves away from the `gen` nomenclature in the directory, since we are going to be adding some extra interface functions to the messages.
72 lines
2.8 KiB
Protocol Buffer
72 lines
2.8 KiB
Protocol Buffer
syntax = "proto3";
|
|
|
|
package controller.api.resources.users.v1;
|
|
|
|
option go_package = "github.com/hashicorp/boundary/sdk/pbs/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 {
|
|
// Output only. The ID of the Account.
|
|
string id = 10;
|
|
|
|
// 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 {
|
|
// Output only. The ID of the User.
|
|
string id = 10;
|
|
|
|
// The ID of the Scope this resource is in.
|
|
string scope_id = 20 [json_name = "scope_id"];
|
|
|
|
// Output only. Scope information for this resource.
|
|
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" }];
|
|
|
|
// Output only. The time this resource was created.
|
|
google.protobuf.Timestamp created_time = 60 [json_name = "created_time"];
|
|
|
|
// Output only. The time this resource was last updated.
|
|
google.protobuf.Timestamp updated_time = 70 [json_name = "updated_time"];
|
|
|
|
// Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
|
|
// The mutation will fail if the version does not match the latest known good version.
|
|
uint32 version = 80;
|
|
|
|
// Output only. Contains the list of Account IDs linked to this User.
|
|
repeated string account_ids = 90 [json_name = "account_ids"];
|
|
|
|
// Output only. The Accounts linked to this User.
|
|
repeated Account accounts = 100;
|
|
|
|
// Output only. The available actions on this resource for this user.
|
|
repeated string authorized_actions = 300 [json_name = "authorized_actions"];
|
|
|
|
// Output only. login_name is a string that maps to the user's account "login
|
|
// name" from the scope's primary auth method
|
|
string login_name = 110 [json_name = "login_name"];
|
|
|
|
// Output only. full_name is a string that maps to the user's account name
|
|
// from the scope's primary auth method
|
|
string full_name = 120 [json_name = "full_name"];
|
|
|
|
// Output only. email is a string that maps to the user's account email from
|
|
// the scope's primary auth method
|
|
string email = 130 [json_name = "email"];
|
|
|
|
// 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"];
|
|
}
|