nhyatt/bitwarden
1
0
Fork 0
mirror of https://github.com/bitwarden/server.git synced 2025-05-29 07:14:50 -05:00
Code

doc: updating emergency access documentation.

Browse Source
This commit is contained in:
Ike Kottlowski 2025-05-27 16:03:36 -04:00
parent f62d63aefd
commit ae238211fc
No known key found for this signature in database
GPG Key ID: C86308E3DCA6D76F
3 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/Api/Auth/Models/Response/EmergencyAccessResponseModel.cs
View File

@ -95,7 +95,7 @@ public class EmergencyAccessTakeoverResponseModel : ResponseModel
/// </summary>
/// <param name="emergencyAccess">Consumed for the Encrypted Key value</param>
/// <param name="grantor">consumed for the KDF configuration</param>
/// <param name="obj">name of the objet</param>
/// <param name="obj">name of the object</param>
/// <exception cref="ArgumentNullException">emergencyAccess cannot be null</exception>
public EmergencyAccessTakeoverResponseModel(EmergencyAccess emergencyAccess, User grantor, string obj = "emergencyAccessTakeover") : base(obj)
{

4
src/Core/Auth/Services/EmergencyAccess/IEmergencyAccessService.cs
View File

@ -76,14 +76,14 @@ public interface IEmergencyAccessService
/// <returns>void</returns>
Task InitiateAsync(Guid emergencyAccessId, User granteeUser);
/// <summary>
/// Approves a recovery request. Set's the EmergencyAccess.Status to RecoveryApproved.
/// Approves a recovery request. Sets the EmergencyAccess.Status to RecoveryApproved.
/// </summary>
/// <param name="emergencyAccessId">emergency access id</param>
/// <param name="grantorUser">grantor user</param>
/// <returns>void</returns>
Task ApproveAsync(Guid emergencyAccessId, User grantorUser);
/// <summary>
/// Rejects a recovery request. Set's the EmergencyAccess.Status to Confirmed. This does not remove the emergency access entity. The
/// Rejects a recovery request. Sets the EmergencyAccess.Status to Confirmed. This does not remove the emergency access entity. The
/// Grantee user can still initiate another recovery request.
/// </summary>
/// <param name="emergencyAccessId">emergency access id</param>

2
src/Core/Auth/Services/EmergencyAccess/readme.md
View File

@ -8,7 +8,7 @@ This system is affected by the Key Rotation feature. The `EmergencyAccess.KeyEnc
## Special Cases
Users who use `KeyConnector` are not able to allow `Takeover` of their accounts. However, they can allow `View`.
A user who is not the `OrganizationUserType.Owner` will be removed from the organization.
When a grantee user _takes over_ a grantor user's account, the grantor user will be removed from all organizations where the grantor user is not the `OrganizationUserType.Owner`. A grantor user will not be removed from organizations if the `EmergencyAccessType` is `View`. The grantee user will only be able to `View` the grantor user's ciphers, and not any of the organization ciphers, if any exist.
## Step 1. Invitation