Skip to content

Commit

Permalink
GITBOOK-1059: Assign roles to a user in SR
Browse files Browse the repository at this point in the history
  • Loading branch information
Dibik K authored and gitbook-bot committed Sep 6, 2024
1 parent bb9815c commit f771fb9
Show file tree
Hide file tree
Showing 10 changed files with 80 additions and 10 deletions.
Binary file added .gitbook/assets/access-rights-sr.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/account-security-tab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/main-menu-sr.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/oauth-tab-sr.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/user-companies-users.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/user-list-sr (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 3 additions & 2 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,8 @@
* [Administration / User Management](social-registry/functionality/administration/README.md)
* [User Roles](social-registry/functionality/administration/user-roles.md)
* [📔 User Guide](social-registry/functionality/administration/user-guide/README.md)
* [📔 Create User and Assign Role](social-registry/functionality/administration/user-guide/create-user-and-assign-role.md)
* [📔 Create User](social-registry/functionality/administration/user-guide/create-user.md)
* [📔 Assign a Role to a User](social-registry/functionality/administration/user-guide/assign-a-role-to-a-user.md)
* [Geographic](social-registry/functionality/geographic.md)
* [MOSIP ID Validation and Tokenization](social-registry/features/id-verification.md)
* [Data Share](social-registry/features/data-share.md)
Expand Down Expand Up @@ -441,7 +442,7 @@
* [No Space Left on the Device Warning](deployment/deployment-guide/troubleshooting/no-space-left-on-the-device-warning.md)
* [Restart Deployment or StatefulSets to Redistribute Pods across Nodes](deployment/deployment-guide/redistribute-pods-across-nodes-by-restarting-deployment-statefulsets.md)
* [Rerun Jobs in Kubernetes Cluster](deployment/deployment-guide/rerun-jobs-in-kubernetes-cluster.md)
* [Persistent Storage](deployment/persistent-storage/README.md)
* [Persistent Storage](deployment/persistent-storage.md)
* [Resizing Persistent Volume Claim in Kubernetes Cluster](deployment/persistent-storage/resizing-persistent-volume-claim-in-kubernetes-cluster.md)
* [Documentation Guides](documentation-guides/README.md)
* [Documentation Guidelines](documentation-guides/documentation-guidelines/README.md)
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# 📔 Assign a Role to a User

This document provides instructions to assign a role to a user in Social Registry module.

## Prerequisites

* The user must have access to the Social Registry module.
* The user must have Administrator role.

Note:

Enable a debug mode, when you assign a role to a user.

## Procedure

1. Click the main menu icon ![](../../../../.gitbook/assets/main-menu.png) and select _**Settings**_.

<figure><img src="../../../../.gitbook/assets/main-menu-sr.png" alt=""><figcaption></figcaption></figure>

2. Click the tab _**Users & Companies**_ and select _**Users**_.

<figure><img src="../../../../.gitbook/assets/user-companies-users.png" alt=""><figcaption></figcaption></figure>

The _**Users**_ screen is displayed.

3. Click the _**User**_ to assign a role in the Users list.

For example, here Demo user is selected to assign a role.

<figure><img src="../../../../.gitbook/assets/user-list-sr (1).png" alt=""><figcaption></figcaption></figure>

The Demo user screen is displayed

4. Click the _**Access Rights**_ tab.

<figure><img src="../../../../.gitbook/assets/access-rights-sr.png" alt=""><figcaption></figcaption></figure>

The following list of fields includes descriptions of each that must be filled out to assign a role and provide relevant access to the user.

<table><thead><tr><th width="218"></th><th></th></tr></thead><tbody><tr><td>USER TYPE</td><td></td></tr><tr><td>User types</td><td><p>Select the appropriate user types. The valid values are:</p><ul><li>Internal User</li><li>Portal</li><li>Public</li></ul></td></tr><tr><td>ACCOUNTING</td><td></td></tr><tr><td><ul><li>Invoicing </li><li>Bank</li></ul></td><td>Retain the default values.</td></tr><tr><td>WEBSITE</td><td></td></tr><tr><td>Website</td><td>Retain the default values.</td></tr><tr><td>ADMINISTRATION</td><td></td></tr><tr><td>Administration</td><td><p>Select the appropriate values. The valid values are:</p><ul><li>Access Rights</li><li>Settings</li></ul><p>Note:</p><p>The Settings option must be chosen from the drop-down only for the <em><strong>Administrator</strong></em> role.</p></td></tr><tr><td>OTHER</td><td></td></tr><tr><td><ul><li>Job Queue </li><li>Dashboard</li></ul></td><td>Retain the default values.</td></tr><tr><td>OPENG2P MODULE ACCESS</td><td></td></tr><tr><td>Administrator</td><td>Check the box, if the user needs to be assigned as a <em><strong>Administrator</strong></em> role.</td></tr><tr><td>Registrar</td><td>Check the box, if the user needs to be assigned as a <em><strong>Registrar</strong></em> role.</td></tr><tr><td>OPENG2P SECURITY MODULE</td><td></td></tr><tr><td>Crypto Admin</td><td>When the user installs the <em><strong>Security</strong></em> module, the <em><strong>Crypto Admin</strong></em> option is checked as needed.</td></tr><tr><td>Crypto Dummy</td><td>When the user installs the <em><strong>Security</strong></em> module, the <em><strong>Crypto Dummy</strong></em> option is checked as needed.</td></tr><tr><td>OPENG2P DOCUMENTS MODULE</td><td></td></tr><tr><td>Document Admin</td><td>When the user installs the <em><strong>Documents</strong></em> module, the <em><strong>Document Admin</strong></em> option is checked as needed.</td></tr><tr><td>Document Write</td><td>When the user installs the <em><strong>Documents</strong></em> module, the <em><strong>Document Write</strong></em> option is checked as needed.</td></tr><tr><td>Document Read</td><td>When the user installs the <em><strong>Document</strong></em> module, the <em><strong>Document Read</strong></em> option is checked as needed.</td></tr><tr><td>OPENG2P REST API</td><td></td></tr><tr><td>Rest API GET</td><td>The <strong>Rest API GET</strong> option is checked, if the authenticated/authorised user accesses the OpenG2P Rest API as needed.</td></tr><tr><td>Rest API POST</td><td>The <em><strong>Rest API POST</strong></em> option is checked, if the authenticated/authorised user accesses the OpenG2P Rest API as needed.</td></tr><tr><td>TECHNICAL</td><td><p>The options listed below this section are out-of-the-box Odoo options.</p><p>Select the appropriate options from the list as needed.</p><p></p><p>Note:</p><p>Mostly the options <em><strong>Access to export feature</strong></em> and <em><strong>Mail Template Editor</strong></em> are checked.</p></td></tr><tr><td>FASTAPI</td><td>The options listed below this section are checked only for the authenticated/authorised user who has access to the <em><strong>FAST API</strong></em> as needed.</td></tr><tr><td>EXTRA RIGHTS</td><td><p>The options listed below this section are checked for the user who needs access to extra options.</p><p></p><p>Note:</p><p>Mostly the option <em><strong>Contact Creation</strong></em> is checked.</p></td></tr><tr><td>OTHER</td><td><p>The options listed below this section are checked for the user who needs access to other options.</p><p></p><p>Note:</p><p>Mostly the option <strong>Bypass HTML Field Sanitize</strong> is checked.</p></td></tr></tbody></table>

| Icon | Click to |
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <img src="../../../../.gitbook/assets/Actions.png" alt="" data-size="original"> | <p>Select the appropriate value. The available values are: </p><ul><li>Archive</li><li>Duplicate</li><li>Change Password</li><li>Disable two-factor authentication</li><li>Send Password Reset Instructions</li><li>Privacy Lookup</li></ul> |
| <img src="../../../../.gitbook/assets/icon-save-manually.png" alt="" data-size="original"> | Save the data and exit from the screen. |
| <img src="../../../../.gitbook/assets/discard-changes-icon.png" alt="" data-size="original"> | Discard changes and exit from the screen. |

Now that the Administrator has granted access permissions in Settings, the user can utilise the module as intended.
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ layout:
visible: true
---

# 📔 Create User and Assign Role
# 📔 Create User

This document provides instructions to create user and assign role in the _**Social Registry**_ module.
This document provides instructions to create user in the _**Social Registry**_ module.

## Prerequisites

* The user must have Registrar and Administrator role.
* The user must have access to the Social Registry module.
* The user must have Registrar and Administrator role.

## Procedure

Expand Down Expand Up @@ -53,11 +53,12 @@ In _**Users New**_ screen, the available features and their descriptions are:

The fields and their descriptions are given below:

| Field | Description |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| Website | <p>Select the appropriate value from the drop-down. The available values are </p><ul><li>Restricted Editor</li><li>Editor and Designer</li></ul> |
| Administration | <p>Select the appropriate value from the drop-down. The available values are </p><ul><li>Access Rights</li><li>Settings</li></ul> |
| Job Queue | <p></p><p>Select the appropriate value from the drop-down. The available values are </p><ul><li>Job Queue Manager</li></ul> |
| Field | Description |
| -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Accounting | <p><em><strong>Invoicing</strong></em></p><p>Select the appropriate value from the drop-down. The available values are</p><ul><li>Billing </li><li>Billing Administrator</li></ul><p><em><strong>Bank</strong></em></p><p>Select the appropriate value from the drop-down, The available value is </p><ul><li>Validate bank account</li></ul> |
| Website | <p>Select the appropriate value from the drop-down. The available values are </p><ul><li>Restricted Editor</li><li>Editor and Designer</li></ul> |
| Administration | <p>Select the appropriate value from the drop-down. The available values are </p><ul><li>Access Rights</li><li>Settings</li></ul> |
| Other | <p><em><strong>Job Queue</strong></em></p><p>Select the appropriate value from the drop-down. The available value is</p><ul><li>Job Queue Manager</li></ul><p><em><strong>Dashboard</strong></em></p><p>Select the appropriate value from the drop-down. The available value is</p><ul><li>Admin</li></ul> |

5. Click the _**Preferences**_ tab.

Expand All @@ -74,6 +75,24 @@ The fields and their descriptions are given below:

<figure><img src="../../../../.gitbook/assets/user-new-filled-screen-sr.png" alt=""><figcaption></figcaption></figure>

6. Click the _**Oauth**_ tab.

<figure><img src="../../../../.gitbook/assets/oauth-tab-sr.png" alt=""><figcaption></figcaption></figure>

The fields and their descriptions are given below:

| Field | Description |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| OAuth Provider | <ul><li>Select the appropriate value from the drop-down. </li></ul><p>(or)</p><ul><li>Search for the OAuth Provider using the Search more option from the drop-down. </li></ul> |
| OAuth User ID | Enter the OAuth user ID. |
| OAuth Access Token | Check the _**OIDC Groups Rest**_ box or _**OIDC Userinfo Reset**_ box as per the requirement |

7. Click the _**Account Security**_ tab.

<figure><img src="../../../../.gitbook/assets/account-security-tab.png" alt=""><figcaption></figcaption></figure>

8. Click the _**Invite to use 2FA**_ button to enable 2FA for a user.

| Icon | Click to |
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <img src="../../../../.gitbook/assets/Actions.png" alt="" data-size="original"> | <p>Select the appropriate value. The available values are: </p><ul><li>Archive</li><li>Duplicate</li><li>Change Password</li><li>Disable two-factor authentication</li><li>Send Password Reset Instructions</li><li>Privacy Lookup</li></ul> |
Expand All @@ -83,3 +102,5 @@ The fields and their descriptions are given below:
The newly created user is added to the user list.

<figure><img src="../../../../.gitbook/assets/user-list-sr.png" alt=""><figcaption></figcaption></figure>

Assign user role

0 comments on commit f771fb9

Please sign in to comment.