Skip to content

Commit

Permalink
[docs-only] added missing documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
glpatcern committed Sep 6, 2024
1 parent 2b4484f commit 7e69288
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion cs3/identity/user/v1beta1/resources.proto
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ option java_package = "com.cs3.identity.user.v1beta1";
option objc_class_prefix = "CIU";
option php_namespace = "Cs3\\Identity\\User\\V1Beta1";

// A UserId represents a user.
// A UserId represents a unique identifier of a user.
message UserId {
// REQUIRED.
// The identity provider for the user.
Expand All @@ -46,14 +46,32 @@ message UserId {

// Represents a user of the system.
message User {
// REQUIRED.
// The unique identifier of this user.
UserId id = 1;
// REQUIRED.
// A human-friendly unique identifier of this user.
string username = 2;
// OPTIONAL.
// The e-mail address of this user.
string mail = 3;
// OPTIONAL.
// Whether the e-mail address was verified by the IDP.
bool mail_verified = 4;
// OPTIONAL.
// A human-friendly display name for this user, e.g. "Family and First Name"
string display_name = 5;
// OPTIONAL.
// A list of groups this user belongs to.
repeated string groups = 6;
// OPTIONAL.
// Opaque information.
cs3.types.v1beta1.Opaque opaque = 7;
// OPTIONAL.
// The user id of this user in the Unix world.
int64 uid_number = 8;
// OPTIONAL.
// The group id of this user in the Unix world.
int64 gid_number = 9;
}

Expand Down

0 comments on commit 7e69288

Please sign in to comment.