Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add user type field to user ID #120

Merged
merged 4 commits into from
Apr 26, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions cs3/identity/user/v1beta1/resources.proto
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ message UserId {
// the unique identifier for the user in the scope of
// the identity provider.
string opaque_id = 2;
// REQUIRED.
// The type of user.
UserType type = 3;
}

// Represents a user of the system.
Expand All @@ -53,3 +56,23 @@ message User {
int64 uid_number = 8;
int64 gid_number = 9;
}

// The type of user.
enum UserType {
// The user is invalid, for example, is missing primary attributes.
USER_TYPE_INVALID = 0;
// A primary user.
USER_TYPE_PRIMARY = 1;
// A secondary user for cases with multiple identities.
USER_TYPE_SECONDARY = 2;
// A user catering to specific services.
USER_TYPE_SERVICE = 3;
// A user to be used by specific applications.
USER_TYPE_APPLICATION = 4;
// A guest user not affiliated to the IDP.
USER_TYPE_GUEST = 5;
// A federated user provided by external IDPs.
USER_TYPE_FEDERATED = 6;
// A lightweight user account without access to various major functionalities.
USER_TYPE_LIGHTWEIGHT = 7;
}
71 changes: 71 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -717,6 +717,10 @@ <h2>Table of Contents</h2>
</li>


<li>
<a href="#cs3.identity.user.v1beta1.UserType"><span class="badge">E</span>UserType</a>
</li>



</ul>
Expand Down Expand Up @@ -6201,6 +6205,14 @@ <h3 id="cs3.identity.user.v1beta1.UserId">UserId</h3>
the identity provider. </p></td>
</tr>

<tr>
<td>type</td>
<td><a href="#cs3.identity.user.v1beta1.UserType">UserType</a></td>
<td></td>
<td><p>REQUIRED.
The type of user. </p></td>
</tr>

</tbody>
</table>

Expand All @@ -6210,6 +6222,65 @@ <h3 id="cs3.identity.user.v1beta1.UserId">UserId</h3>



<h3 id="cs3.identity.user.v1beta1.UserType">UserType</h3>
<p>The type of user.</p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
</thead>
<tbody>

<tr>
<td>USER_TYPE_INVALID</td>
<td>0</td>
<td><p>The user is invalid, for example, is missing primary attributes.</p></td>
</tr>

<tr>
<td>USER_TYPE_PRIMARY</td>
<td>1</td>
<td><p>A primary user.</p></td>
</tr>

<tr>
<td>USER_TYPE_SECONDARY</td>
<td>2</td>
<td><p>A secondary user for cases with multiple identities.</p></td>
</tr>

<tr>
<td>USER_TYPE_SERVICE</td>
<td>3</td>
<td><p>A user catering to specific services.</p></td>
</tr>

<tr>
<td>USER_TYPE_APPLICATION</td>
<td>4</td>
<td><p>A user to be used by specific applications.</p></td>
</tr>

<tr>
<td>USER_TYPE_GUEST</td>
<td>5</td>
<td><p>A guest user not affiliated to the IDP.</p></td>
</tr>

<tr>
<td>USER_TYPE_FEDERATED</td>
<td>6</td>
<td><p>A federated user provided by external IDPs.</p></td>
</tr>

<tr>
<td>USER_TYPE_LIGHTWEIGHT</td>
<td>7</td>
<td><p>A lightweight user account without access to various major functionalities.</p></td>
</tr>

</tbody>
</table>




Expand Down