Added new Admin API code examples (#122)

* added new code examples

* adding scope to tests

---------

Co-authored-by: Paige Rossi <paige.rossi@docusign.com>

Author: RomanBachaloSigmaSoftware

app/__init__.py

@@ -56,6 +56,8 @@
 app.register_blueprint(admin_views.aeg007)
 app.register_blueprint(admin_views.aeg008)
 app.register_blueprint(admin_views.aeg009)
+app.register_blueprint(admin_views.aeg010)
+app.register_blueprint(admin_views.aeg011)
 
 app.register_blueprint(click_views.ceg001)
 app.register_blueprint(click_views.ceg002)

app/admin/examples/eg010_delete_user_data_from_organization.py

@@ -0,0 +1,57 @@
+from docusign_admin import ApiClient, UsersApi, OrganizationsApi, IndividualUserDataRedactionRequest, \
+    MembershipDataRedactionRequest
+from flask import session, request
+
+from ...ds_config import DS_CONFIG
+from app.admin.utils import get_organization_id
+
+
+class Eg010DeleteUserDataFromOrganizationController:
+    @staticmethod
+    def get_args():
+        """Get required session and request arguments"""
+        organization_id = get_organization_id()
+        return {
+            "account_id": session["ds_account_id"],  # Represents your {ACCOUNT_ID}
+            "access_token": session["ds_access_token"],  # Represents your {ACCESS_TOKEN}
+            "organization_id": organization_id,  # Represents your {ORGANIZATION_ID},
+            "email": request.form.get("email"),
+        }
+
+    @staticmethod
+    def worker(args):
+        """
+        1. Create an API client with headers
+        2. Get user profile data
+        3. Delete user data
+        """
+
+        access_token = args["access_token"]
+        org_id = args["organization_id"]
+        email = args["email"]
+
+        # Create an API client with headers
+        # Step 2 start
+        api_client = ApiClient(host=DS_CONFIG["admin_api_client_host"])
+        api_client.set_default_header(
+            header_name="Authorization",
+            header_value=f"Bearer {access_token}"
+        )
+        # Step 2 end
+
+        # Step 3 start
+        users_api = UsersApi(api_client=api_client)
+        results = users_api.get_user_ds_profiles_by_email(organization_id=org_id, email=email)
+        user = results.users[0]
+        # Step 3 end
+
+        # Step 4 start
+        organizations_api = OrganizationsApi(api_client=api_client)
+        user_data_redaction_request = IndividualUserDataRedactionRequest(
+            user_id=user.id,
+            memberships=[MembershipDataRedactionRequest(account_id=user.memberships[0].account_id)]
+        )
+        results = organizations_api.redact_individual_user_data(org_id, user_data_redaction_request)
+        # Step 4 end
+
+        return results

app/admin/examples/eg011_delete_user_data_from_account.py

@@ -0,0 +1,43 @@
+from docusign_admin import ApiClient, AccountsApi, IndividualMembershipDataRedactionRequest
+from flask import session, request
+
+from ...ds_config import DS_CONFIG
+
+
+class Eg011DeleteUserDataFromAccountController:
+    @staticmethod
+    def get_args():
+        """Get required session and request arguments"""
+        return {
+            "account_id": session["ds_account_id"],  # Represents your {ACCOUNT_ID}
+            "access_token": session["ds_access_token"],  # Represents your {ACCESS_TOKEN}
+            "user_id": request.form.get("user_id"),
+        }
+
+    @staticmethod
+    def worker(args):
+        """
+        1. Create an API client with headers
+        2. Delete user data
+        """
+
+        access_token = args["access_token"]
+        account_id = args["account_id"]
+        user_id = args["user_id"]
+
+        # Create an API client with headers
+        # Step 2 start
+        api_client = ApiClient(host=DS_CONFIG["admin_api_client_host"])
+        api_client.set_default_header(
+            header_name="Authorization",
+            header_value=f"Bearer {access_token}"
+        )
+        # Step 2 end
+
+        # Step 3 start
+        accounts_api = AccountsApi(api_client=api_client)
+        membership_redaction_request = IndividualMembershipDataRedactionRequest(user_id=user_id)
+        results = accounts_api.redact_individual_membership_data(account_id, membership_redaction_request)
+        # Step 3 end
+
+        return results

app/admin/views/__init__.py

@@ -7,3 +7,5 @@
 from .eg007_get_user_profile_by_user_id import aeg007
 from .eg008_update_user_product_permission_profile import aeg008
 from .eg009_delete_user_product_permission_profile import aeg009
+from .eg010_delete_user_data_from_organization import aeg010
+from .eg011_delete_user_data_from_account import aeg011

app/admin/views/eg010_delete_user_data_from_organization.py

@@ -0,0 +1,62 @@
+"""Example 010: Delete user data from an account as an organization admin. """
+
+import json
+
+from docusign_admin.client.api_exception import ApiException
+from flask import Blueprint, render_template, session
+
+from app.docusign import authenticate, ensure_manifest, get_example_by_number
+from app.error_handlers import process_error
+from ..examples.eg010_delete_user_data_from_organization import Eg010DeleteUserDataFromOrganizationController
+from ...ds_config import DS_CONFIG
+from ...consts import API_TYPE
+
+example_number = 10
+api = API_TYPE["ADMIN"]
+eg = f"aeg0{example_number}"  # Reference (and URL) for this example
+aeg010 = Blueprint(eg, __name__)
+
+
+@aeg010.route(f"/{eg}", methods=["POST"])
+@ensure_manifest(manifest_url=DS_CONFIG["example_manifest_url"])
+@authenticate(eg=eg, api=api)
+def audit_users():
+    """
+    1. Get required arguments
+    2. Call the worker method
+    3. Render the response
+    """
+    example = get_example_by_number(session["manifest"], example_number, api)
+    
+    # 1. Get required arguments
+    args = Eg010DeleteUserDataFromOrganizationController.get_args()
+    try:
+        # 2. Call the worker method to delete user data by email
+        results = Eg010DeleteUserDataFromOrganizationController.worker(args)
+    except ApiException as err:
+        return process_error(err)
+
+    return render_template(
+        "example_done.html",
+        title=example["ExampleName"],
+        message=example["ResultsPageText"],
+        json=json.dumps(json.dumps(results.to_dict(), default=str))
+    )
+
+
+@aeg010.route(f"/{eg}", methods=["GET"])
+@ensure_manifest(manifest_url=DS_CONFIG["example_manifest_url"])
+@authenticate(eg=eg, api=api)
+def get_view():
+    """ Responds with the form for the example"""
+    example = get_example_by_number(session["manifest"], example_number, api)
+
+    return render_template(
+        "admin/eg010_delete_user_data_from_organization.html",
+        title=example["ExampleName"],
+        example=example,
+        source_file="eg010_delete_user_data_from_organization.py",
+        source_url=DS_CONFIG["admin_github_url"] + "eg010_delete_user_data_from_organization.py",
+        documentation=DS_CONFIG["documentation"] + eg,
+    )
+

app/admin/views/eg011_delete_user_data_from_account.py

@@ -0,0 +1,62 @@
+"""Example 011: Delete user data from an account as an account admin. """
+
+import json
+
+from docusign_admin.client.api_exception import ApiException
+from flask import Blueprint, render_template, session
+
+from app.docusign import authenticate, ensure_manifest, get_example_by_number
+from app.error_handlers import process_error
+from ..examples.eg011_delete_user_data_from_account import Eg011DeleteUserDataFromAccountController
+from ...ds_config import DS_CONFIG
+from ...consts import API_TYPE
+
+example_number = 11
+api = API_TYPE["ADMIN"]
+eg = f"aeg0{example_number}"  # Reference (and URL) for this example
+aeg011 = Blueprint(eg, __name__)
+
+
+@aeg011.route(f"/{eg}", methods=["POST"])
+@ensure_manifest(manifest_url=DS_CONFIG["example_manifest_url"])
+@authenticate(eg=eg, api=api)
+def audit_users():
+    """
+    1. Get required arguments
+    2. Call the worker method
+    3. Render the response
+    """
+    example = get_example_by_number(session["manifest"], example_number, api)
+    
+    # 1. Get required arguments
+    args = Eg011DeleteUserDataFromAccountController.get_args()
+    try:
+        # 2. Call the worker method to delete user data by user ID
+        results = Eg011DeleteUserDataFromAccountController.worker(args)
+    except ApiException as err:
+        return process_error(err)
+
+    return render_template(
+        "example_done.html",
+        title=example["ExampleName"],
+        message=example["ResultsPageText"],
+        json=json.dumps(json.dumps(results.to_dict(), default=str))
+    )
+
+
+@aeg011.route(f"/{eg}", methods=["GET"])
+@ensure_manifest(manifest_url=DS_CONFIG["example_manifest_url"])
+@authenticate(eg=eg, api=api)
+def get_view():
+    """ Responds with the form for the example"""
+    example = get_example_by_number(session["manifest"], example_number, api)
+
+    return render_template(
+        "admin/eg011_delete_user_data_from_account.html",
+        title=example["ExampleName"],
+        example=example,
+        source_file="eg011_delete_user_data_from_account.py",
+        source_url=DS_CONFIG["admin_github_url"] + "eg011_delete_user_data_from_account.py",
+        documentation=DS_CONFIG["documentation"] + eg,
+    )
+

app/docusign/ds_client.py

@@ -29,7 +29,7 @@
 
 ADMIN_SCOPES = [
     "signature", "organization_read", "group_read", "permission_read", "user_read", "user_write", 
-    "account_read", "domain_read", "identity_provider_read", "impersonation"
+    "account_read", "domain_read", "identity_provider_read", "impersonation", "user_data_redact"
 ]
 
 

app/templates/admin/eg010_delete_user_data_from_organization.html

@@ -0,0 +1,22 @@
+<!-- extend base layout --> {% extends "base.html" %}  {% block content %}
+
+{% include 'example_info.html' %}
+
+{%  set form_index = 0 %}
+{%  set email_index = 0 %}
+
+<form class="eg" action="" method="post" data-busy="form">
+    {% if 'FormName' in example['Forms'][form_index] %}
+        <p>{{ example['Forms'][form_index]['FormName'] | safe }}</p>
+    {% endif %}
+
+    <div class="form-group">
+        <label for="email">{{ example['Forms'][form_index]['Inputs'][email_index]['InputName'] }}</label>
+        <input type="email" class="form-control" id="email" name="email" placeholder="{{ example['Forms'][form_index]['Inputs'][email_index]['InputPlaceholder'] }}" required>
+        <small id="email_help" class="form-text text-muted">{{ session['manifest']['SupportingTexts']['HelpingTexts']['EmailAddressOfUserToDelete'] | safe}}</small>
+    </div>
+    <input type="hidden" name="csrf_token" value="{{ csrf_token() }}"/>
+    {% include 'continue_button.html' %}
+</form>
+  
+{% endblock %}

app/templates/admin/eg011_delete_user_data_from_account.html

@@ -0,0 +1,24 @@
+<!-- extend base layout --> {% extends "base.html" %}  {% block content %}
+
+{% include 'example_info.html' %}
+
+{%  set form_index = 0 %}
+{%  set user_id_index = 0 %}
+
+<form class="eg" action="" method="post" data-busy="form">
+    {% if 'FormName' in example['Forms'][form_index] %}
+        <p>{{ example['Forms'][form_index]['FormName'] | safe }}</p>
+    {% endif %}
+
+    <div class="form-group">
+        <label for="user_id">{{ example['Forms'][form_index]['Inputs'][user_id_index]['InputName'] }}</label>
+        <input type="text" class="form-control" id="user_id" name="user_id"
+               placeholder="{{ example['Forms'][form_index]['Inputs'][user_id_index]['InputPlaceholder'] }}" required
+               pattern="[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}">
+        <small id="user_id_help" class="form-text text-muted">{{ session['manifest']['SupportingTexts']['HelpingTexts']['UserIDOfUserToDelete'] | safe}}</small>
+    </div>
+    <input type="hidden" name="csrf_token" value="{{ csrf_token() }}"/>
+    {% include 'continue_button.html' %}
+</form>
+  
+{% endblock %}

app/tests/test_config.py

@@ -20,7 +20,7 @@ def get_configuration():
                          "dtr.company.read", "dtr.company.write", "room_forms"],
         "admin_scopes": ["organization_read", "group_read", "permission_read",
                          "user_read", "user_write", "account_read",
-                         "domain_read", "identity_provider_read"],
+                         "domain_read", "identity_provider_read", "user_data_redact"],
         "expires_in": 3600,
         "test_pdf_file": './app/tests/docs/World_Wide_Corp_lorem.pdf',
         "test_docx_file": './app/tests/docs/World_Wide_Corp_Battle_Plan_Trafalgar.docx',