This repository has been archived by the owner on Nov 9, 2017. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add admin role assignment feature documentation
Squashed commit of the following: commit cfe6096 Author: Alex Eng <aeng@redhat.com> Date: Tue May 5 16:15:30 2015 +1000 Add admin role assignment doc
- Loading branch information
Alex Eng
committed
May 5, 2015
1 parent
9201cfb
commit 85e6ed6
Showing
9 changed files
with
71 additions
and
1 deletion.
There are no files selected for viewing
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
'Role assignment rules' are Zanata's way of dynamically assigning security roles and even Project access to users. | ||
To configure Role Assignment Rules, admin users must go to the Administration section and click 'Role assignment rules' button. | ||
|
||
<figure> | ||
<img alt="Role Assignment Rules Location" src="images/role-assignment-access.png" /> | ||
</figure> | ||
<br/> | ||
|
||
|
||
### Overview | ||
|
||
<figure> | ||
<img alt="Role Assignment Rules overview" src="images/role-assignment-view.png" /> | ||
</figure> | ||
<br/> | ||
|
||
1. **Policy Name:** This is the type of authentication system that a user logs in with (Open Id, Internal Authentication, etc). | ||
|
||
2. **Role To Assign:** This is the Role that will be assigned to the user upon login, if the Policy name and Identity pattern match. | ||
|
||
3. **Identity Pattern:** This is a Regular expression that will be matched against the user's authenticated identity (most of the time this is the user name, but for Open Id, it's the Open Id itself). | ||
|
||
|
||
### How it works | ||
|
||
1. User Logs in. | ||
2. Authentication Policy is checked. If the user logged in using the authentication policy declared in the rule, continue to the next step. Otherwise, this rule is not applied. | ||
3. Identity Patter is checked. If the user's name (or Open Id) matches the pattern described in the rule, continue to the next step. Otherwise, this rule is not applied. | ||
4. The user is assigned the role stated in the Rule. Process subsequent rules. | ||
|
||
### Adding new rules | ||
|
||
1. Navigate to 'Role assignment rules' page. | ||
1. Click on `More Action` menu on the top right panel. | ||
<figure> | ||
<img alt="Role Assignment Rules new" src="images/role-assignment-new-access.png" /> | ||
</figure> | ||
<br/> | ||
1. Select `New Rule`. | ||
<figure> | ||
<img alt="Role Assignment Rules new form" src="images/role-assignment-new-form.png" /> | ||
</figure> | ||
<br/> | ||
1. Fill in the fields and click `Save`. | ||
|
||
### Deleting rules | ||
|
||
1. Navigate to 'Role assignment rules' page. | ||
1. Locate the rule you wish to delete, click on `Options` menu in front of the row. | ||
1. Click `Delete` to remove the rule. | ||
<figure> | ||
<img alt="Role Assignment delete" src="images/role-assignment-delete.png" /> | ||
</figure> | ||
<br/> | ||
|
||
|
||
### Restricting Project Access to User Roles | ||
|
||
To complement the dynamic role assignment described above, Zanata can now restrict project access by roles. | ||
To restrict project access, | ||
|
||
1. Go to project settings page. | ||
1. Click on `Permission` tab. | ||
1. Check `Restrict access to certain user roles` and select roles that you wish to allow access to your project. | ||
<figure> | ||
<img alt="Role Assignment project" src="images/role-assignment-project.png" /> | ||
</figure> | ||
<br/> | ||
1. Any role restrictions will now be seen on the project's page and only users belonging to that role will be able to work on the project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters