Add docs for: `Optional admin approval for local user sign up` feature
What does this MR do?
Add documentation for the feature built for &4491 - Optional admin approval for local user sign up
A short walkthru video explaining the change is available here (Update: Slightly outdated now, as the discussion @ !44877 (comment 428615050) lead us to removing the "force confirm email" part from the approval flow)
Screenshots
- Sign up restriction
Message: When enabled, any user visiting http://localhost:3000/users/sign_in and creating an account will have to be explicitly approved by an admin before they can sign in. This setting is effective only if sign-ups are enabled.
- A new user signs up:
Message - "You have signed up successfully. However, we could not sign you in because your account is awaiting approval from your GitLab administrator."
- This user pending approval tries to sign in:
Message - "Your account is pending approval from your GitLab administrator and hence blocked. Please contact your GitLab administrator if you think this is an error."
- This user pending approval tries to access API/Git:
Message - "Your account is pending approval from your administrator and hence blocked."
- Approval page for admin:
Message:
This user has requested access
Approved users can:
- Log in
- Access Git repositories
- Access the API
- Be added to groups and projects
Does this MR meet the acceptance criteria?
Conformity
-
Changelog entry -
Documentation (if required) -
Code review guidelines -
Merge request performance guidelines -
Style guides -
Database guides -
Separation of EE specific content
Availability and Testing
-
Review and add/update tests for this feature/bug. Consider all test levels. See the Test Planning Process. -
Tested in all supported browsers -
Informed Infrastructure department of a default or new setting change, if applicable per definition of done
Security
If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:
-
Label as security and @ mention @gitlab-com/gl-security/appsec -
The MR includes necessary changes to maintain consistency between UI, API, email, or other methods -
Security reports checked/validated by a reviewer from the AppSec team