Skip to content

Commit 5cf08a1

Browse files
committed
Clearer documentation
1 parent a5b0412 commit 5cf08a1

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

src/Core/AdminConsole/OrganizationFeatures/OrganizationUsers/SelfRevokeUser/ISelfRevokeOrganizationUserCommand.cs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,13 @@ public interface ISelfRevokeOrganizationUserCommand
1010
{
1111
/// <summary>
1212
/// Revokes a user from an organization.
13-
/// Validates the OrganizationDataOwnership policy is enabled and applies to the user (currently Owners/Admins are exempt),
14-
/// the user is a confirmed member, and prevents the last owner from revoking themselves.
1513
/// </summary>
1614
/// <param name="organizationId">The organization ID.</param>
1715
/// <param name="userId">The user ID to revoke.</param>
1816
/// <returns>A <see cref="CommandResult"/> indicating success or containing an error.</returns>
17+
/// <remarks>
18+
/// Validates the OrganizationDataOwnership policy is enabled and applies to the user (currently Owners/Admins are exempt),
19+
/// the user is a confirmed member, and prevents the last owner from revoking themselves.
20+
/// </remarks>
1921
Task<CommandResult> SelfRevokeUserAsync(Guid organizationId, Guid userId);
2022
}

src/Core/AdminConsole/OrganizationFeatures/Policies/PolicyRequirements/OrganizationDataOwnershipPolicyRequirement.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,9 @@ public bool IgnoreStorageLimitsOnMigration(Guid organizationId)
9191
/// </summary>
9292
/// <param name="organizationId">The organization ID to check.</param>
9393
/// <returns>True if the user is eligible for self-revocation (policy applies to them), false otherwise.</returns>
94+
/// <remarks>
95+
/// Self-revoke is used to opt out of migrating the user's personal vault to the organization as required by this policy.
96+
/// </remarks>
9497
public bool EligibleForSelfRevoke(Guid organizationId)
9598
{
9699
var policyDetail = _policyDetails

0 commit comments

Comments
 (0)