Show a user's effective permissions on a site, list, folder, or file.

Permissions

Requires read access to the target scope.

Reference

• https://learn.microsoft.com/en-us/sharepoint/dev/apis/permissions-api-reference

View source

import argparse
import sys

from office365.sharepoint.client_context import ClientContext
from office365.sharepoint.permissions.securable_object import SecurableObject
from tests.settings import cert_path, cert_thumbprint, client_id, site_url, tenant


def _resolve_scope(ctx: ClientContext, args: argparse.Namespace) -> SecurableObject:
    try:
        return ctx.web.get_securable_object(args.scope, list_title=args.list_title, url=args.url)
    except ValueError as e:
        sys.exit(str(e))


def main():
    parser = argparse.ArgumentParser(description="Show a user's effective permissions")
    parser.add_argument(
        "--scope",
        choices=["site", "list", "folder", "file"],
        required=True,
        help="permission scope (site, list, folder, file)",
    )
    parser.add_argument("--list", dest="list_title", default=None, help="list title (for --scope list)")
    parser.add_argument("--url", default=None, help="server-relative URL (for --scope folder/file)")
    parser.add_argument("--principal", default=None, help="user login/UPN (default: current user)")
    args = parser.parse_args()

    ctx = ClientContext(site_url).with_client_certificate(
        tenant, client_id=client_id, thumbprint=cert_thumbprint, cert_path=cert_path
    )
    target = _resolve_scope(ctx, args)
    principal = args.principal or ctx.web.current_user
    result = target.get_user_effective_permissions(principal).execute_query()
    levels = list(result.value.permission_levels)
    print(f"Effective permissions for {args.principal or 'current user'}: {levels or 'none'}")


if __name__ == "__main__":
    main()

---

← Back to Permissions