pltr-cli 0.11.0__py3-none-any.whl → 0.13.0__py3-none-any.whl

pltr/commands/admin.py

@@ -4,7 +4,7 @@ Provides commands for user, group, role, and organization management.
 """
 
 from pathlib import Path
-from typing import Optional
+from typing import List, Optional
 
 import typer
 from rich.console import Console
@@ -12,6 +12,7 @@ from rich.console import Console
 from ..services.admin import AdminService
 from ..utils.formatting import OutputFormatter
 from ..utils.progress import SpinnerProgressTracker
+from ..utils.pagination import PaginationConfig
 
 # Create the main admin app
 app = typer.Typer(
@@ -23,12 +24,14 @@ user_app = typer.Typer(name="user", help="User management operations")
 group_app = typer.Typer(name="group", help="Group management operations")
 role_app = typer.Typer(name="role", help="Role management operations")
 org_app = typer.Typer(name="org", help="Organization management operations")
+marking_app = typer.Typer(name="marking", help="Marking management operations")
 
 # Add sub-apps to main admin app
 app.add_typer(user_app, name="user")
 app.add_typer(group_app, name="group")
 app.add_typer(role_app, name="role")
 app.add_typer(org_app, name="org")
+app.add_typer(marking_app, name="marking")
 
 
 # User Management Commands
@@ -44,28 +47,60 @@ def list_users(
         None, "--output", help="Save results to file"
     ),
     page_size: Optional[int] = typer.Option(
-        None, "--page-size", help="Number of users per page"
+        None, "--page-size", help="Number of users per page (default: from settings)"
+    ),
+    max_pages: Optional[int] = typer.Option(
+        1, "--max-pages", help="Maximum number of pages to fetch (default: 1)"
     ),
     page_token: Optional[str] = typer.Option(
-        None, "--page-token", help="Pagination token from previous response"
+        None, "--page-token", help="Page token to resume from previous response"
+    ),
+    all: bool = typer.Option(
+        False, "--all", help="Fetch all available pages (overrides --max-pages)"
     ),
 ) -> None:
-    """List all users in the organization."""
+    """
+    List users in the organization with pagination support.
+
+    By default, fetches only the first page of results. Use --all to fetch all users,
+    or --max-pages to control how many pages to fetch.
+
+    Examples:
+        # List first page of users (default)
+        pltr admin user list
+
+        # List all users
+        pltr admin user list --all
+
+        # List first 3 pages
+        pltr admin user list --max-pages 3
+
+        # Resume from a specific page
+        pltr admin user list --page-token abc123
+    """
     console = Console()
     formatter = OutputFormatter()
 
     try:
         service = AdminService(profile=profile)
 
+        # Create pagination config
+        config = PaginationConfig(
+            page_size=page_size,
+            max_pages=max_pages,
+            page_token=page_token,
+            fetch_all=all,
+        )
+
         with SpinnerProgressTracker().track_spinner("Fetching users..."):
-            result = service.list_users(page_size=page_size, page_token=page_token)
+            result = service.list_users_paginated(config)
 
-        # Format and display results
+        # Format and display paginated results
         if output_file:
-            formatter.save_to_file(result, output_file, output_format)
-            console.print(f"Results saved to {output_file}")
+            formatter.format_paginated_output(result, output_format, str(output_file))
+            console.print(f"[green]Results saved to {output_file}[/green]")
         else:
-            formatter.display(result, output_format)
+            formatter.format_paginated_output(result, output_format)
 
     except Exception as e:
         console.print(f"[red]Error:[/red] {e}")
@@ -258,6 +293,78 @@ def revoke_user_tokens(
         raise typer.Exit(code=1)
 
 
+@user_app.command("delete")
+def delete_user(
+    user_id: str = typer.Argument(..., help="User ID or RID"),
+    profile: Optional[str] = typer.Option(
+        None, "--profile", help="Auth profile to use"
+    ),
+    confirm: bool = typer.Option(False, "--confirm", help="Skip confirmation prompt"),
+) -> None:
+    """Delete a specific user."""
+    console = Console()
+
+    # Confirmation prompt
+    if not confirm:
+        user_confirm = typer.confirm(f"Are you sure you want to delete user {user_id}?")
+        if not user_confirm:
+            console.print("Operation cancelled.")
+            return
+
+    try:
+        service = AdminService(profile=profile)
+
+        with SpinnerProgressTracker().track_spinner(f"Deleting user {user_id}..."):
+            result = service.delete_user(user_id)
+
+        console.print(f"[green]{result['message']}[/green]")
+
+    except Exception as e:
+        console.print(f"[red]Error:[/red] {e}")
+        raise typer.Exit(code=1)
+
+
+@user_app.command("batch-get")
+def batch_get_users(
+    user_ids: List[str] = typer.Argument(
+        ..., help="User IDs or RIDs (space-separated, max 500)"
+    ),
+    profile: Optional[str] = typer.Option(
+        None, "--profile", help="Auth profile to use"
+    ),
+    output_format: str = typer.Option(
+        "table", "--format", help="Output format (table, json, csv)"
+    ),
+    output_file: Optional[Path] = typer.Option(
+        None, "--output", help="Save results to file"
+    ),
+) -> None:
+    """Batch retrieve multiple users (max 500)."""
+    console = Console()
+    formatter = OutputFormatter()
+
+    try:
+        service = AdminService(profile=profile)
+
+        with SpinnerProgressTracker().track_spinner(
+            f"Fetching {len(user_ids)} users..."
+        ):
+            result = service.get_batch_users(user_ids)
+
+        if output_file:
+            formatter.save_to_file(result, output_file, output_format)
+            console.print(f"Results saved to {output_file}")
+        else:
+            formatter.display(result, output_format)
+
+    except ValueError as e:
+        console.print(f"[red]Error:[/red] {e}")
+        raise typer.Exit(code=1)
+    except Exception as e:
+        console.print(f"[red]Error:[/red] {e}")
+        raise typer.Exit(code=1)
+
+
 # Group Management Commands
 @group_app.command("list")
 def list_groups(
@@ -287,12 +394,22 @@ def list_groups(
         with SpinnerProgressTracker().track_spinner("Fetching groups..."):
             result = service.list_groups(page_size=page_size, page_token=page_token)
 
+        # Extract data from result (service returns {data: [...], next_page_token: ...})
+        groups = result.get("data", [])
+        next_token = result.get("next_page_token")
+
         # Format and display results
         if output_file:
-            formatter.save_to_file(result, output_file, output_format)
+            formatter.save_to_file(groups, output_file, output_format)
             console.print(f"Results saved to {output_file}")
         else:
-            formatter.display(result, output_format)
+            formatter.display(groups, output_format)
+
+        # Show pagination info
+        if next_token:
+            console.print(
+                f"\n[dim]More results available. Use --page-token {next_token} to continue[/dim]"
+            )
 
     except Exception as e:
         console.print(f"[red]Error:[/red] {e}")
@@ -456,6 +573,47 @@ def delete_group(
         raise typer.Exit(code=1)
 
 
+@group_app.command("batch-get")
+def batch_get_groups(
+    group_ids: List[str] = typer.Argument(
+        ..., help="Group IDs or RIDs (space-separated, max 500)"
+    ),
+    profile: Optional[str] = typer.Option(
+        None, "--profile", help="Auth profile to use"
+    ),
+    output_format: str = typer.Option(
+        "table", "--format", help="Output format (table, json, csv)"
+    ),
+    output_file: Optional[Path] = typer.Option(
+        None, "--output", help="Save results to file"
+    ),
+) -> None:
+    """Batch retrieve multiple groups (max 500)."""
+    console = Console()
+    formatter = OutputFormatter()
+
+    try:
+        service = AdminService(profile=profile)
+
+        with SpinnerProgressTracker().track_spinner(
+            f"Fetching {len(group_ids)} groups..."
+        ):
+            result = service.get_batch_groups(group_ids)
+
+        if output_file:
+            formatter.save_to_file(result, output_file, output_format)
+            console.print(f"Results saved to {output_file}")
+        else:
+            formatter.display(result, output_format)
+
+    except ValueError as e:
+        console.print(f"[red]Error:[/red] {e}")
+        raise typer.Exit(code=1)
+    except Exception as e:
+        console.print(f"[red]Error:[/red] {e}")
+        raise typer.Exit(code=1)
+
+
 # Role Management Commands
 @role_app.command("get")
 def get_role(
@@ -492,6 +650,47 @@ def get_role(
         raise typer.Exit(code=1)
 
 
+@role_app.command("batch-get")
+def batch_get_roles(
+    role_ids: List[str] = typer.Argument(
+        ..., help="Role IDs or RIDs (space-separated, max 500)"
+    ),
+    profile: Optional[str] = typer.Option(
+        None, "--profile", help="Auth profile to use"
+    ),
+    output_format: str = typer.Option(
+        "table", "--format", help="Output format (table, json, csv)"
+    ),
+    output_file: Optional[Path] = typer.Option(
+        None, "--output", help="Save results to file"
+    ),
+) -> None:
+    """Batch retrieve multiple roles (max 500)."""
+    console = Console()
+    formatter = OutputFormatter()
+
+    try:
+        service = AdminService(profile=profile)
+
+        with SpinnerProgressTracker().track_spinner(
+            f"Fetching {len(role_ids)} roles..."
+        ):
+            result = service.get_batch_roles(role_ids)
+
+        if output_file:
+            formatter.save_to_file(result, output_file, output_format)
+            console.print(f"Results saved to {output_file}")
+        else:
+            formatter.display(result, output_format)
+
+    except ValueError as e:
+        console.print(f"[red]Error:[/red] {e}")
+        raise typer.Exit(code=1)
+    except Exception as e:
+        console.print(f"[red]Error:[/red] {e}")
+        raise typer.Exit(code=1)
+
+
 # Organization Management Commands
 @org_app.command("get")
 def get_organization(
@@ -528,3 +727,358 @@ def get_organization(
     except Exception as e:
         console.print(f"[red]Error:[/red] {e}")
         raise typer.Exit(code=1)
+
+
+@org_app.command("create")
+def create_organization(
+    name: str = typer.Argument(..., help="Organization name"),
+    enrollment_rid: str = typer.Option(..., "--enrollment-rid", help="Enrollment RID"),
+    profile: Optional[str] = typer.Option(
+        None, "--profile", help="Auth profile to use"
+    ),
+    admin_ids: Optional[List[str]] = typer.Option(
+        None, "--admin-id", help="Admin user IDs (can specify multiple)"
+    ),
+    output_format: str = typer.Option(
+        "table", "--format", help="Output format (table, json, csv)"
+    ),
+    output_file: Optional[Path] = typer.Option(
+        None, "--output", help="Save results to file"
+    ),
+) -> None:
+    """Create a new organization."""
+    console = Console()
+    formatter = OutputFormatter()
+
+    try:
+        service = AdminService(profile=profile)
+
+        with SpinnerProgressTracker().track_spinner(
+            f"Creating organization '{name}'..."
+        ):
+            result = service.create_organization(
+                name=name, enrollment_rid=enrollment_rid, admin_ids=admin_ids
+            )
+
+        if output_file:
+            formatter.save_to_file(result, output_file, output_format)
+            console.print(f"Results saved to {output_file}")
+        else:
+            formatter.display(result, output_format)
+            console.print(f"[green]Organization '{name}' created successfully[/green]")
+
+    except Exception as e:
+        console.print(f"[red]Error:[/red] {e}")
+        raise typer.Exit(code=1)
+
+
+@org_app.command("replace")
+def replace_organization(
+    organization_rid: str = typer.Argument(..., help="Organization RID"),
+    name: str = typer.Argument(..., help="New organization name"),
+    profile: Optional[str] = typer.Option(
+        None, "--profile", help="Auth profile to use"
+    ),
+    description: Optional[str] = typer.Option(
+        None, "--description", help="New organization description"
+    ),
+    output_format: str = typer.Option(
+        "table", "--format", help="Output format (table, json, csv)"
+    ),
+    output_file: Optional[Path] = typer.Option(
+        None, "--output", help="Save results to file"
+    ),
+    confirm: bool = typer.Option(False, "--confirm", help="Skip confirmation prompt"),
+) -> None:
+    """Replace/update an existing organization."""
+    console = Console()
+    formatter = OutputFormatter()
+
+    if not confirm:
+        user_confirm = typer.confirm(
+            f"Are you sure you want to replace organization {organization_rid}?"
+        )
+        if not user_confirm:
+            console.print("Operation cancelled.")
+            return
+
+    try:
+        service = AdminService(profile=profile)
+
+        with SpinnerProgressTracker().track_spinner(
+            f"Replacing organization {organization_rid}..."
+        ):
+            result = service.replace_organization(
+                organization_rid=organization_rid, name=name, description=description
+            )
+
+        if output_file:
+            formatter.save_to_file(result, output_file, output_format)
+            console.print(f"Results saved to {output_file}")
+        else:
+            formatter.display(result, output_format)
+            console.print(
+                f"[green]Organization '{organization_rid}' replaced successfully[/green]"
+            )
+
+    except Exception as e:
+        console.print(f"[red]Error:[/red] {e}")
+        raise typer.Exit(code=1)
+
+
+@org_app.command("available-roles")
+def list_available_roles(
+    organization_rid: str = typer.Argument(..., help="Organization RID"),
+    profile: Optional[str] = typer.Option(
+        None, "--profile", help="Auth profile to use"
+    ),
+    output_format: str = typer.Option(
+        "table", "--format", help="Output format (table, json, csv)"
+    ),
+    output_file: Optional[Path] = typer.Option(
+        None, "--output", help="Save results to file"
+    ),
+    page_size: Optional[int] = typer.Option(
+        None, "--page-size", help="Number of roles per page"
+    ),
+    page_token: Optional[str] = typer.Option(
+        None, "--page-token", help="Pagination token from previous response"
+    ),
+) -> None:
+    """List available roles for an organization."""
+    console = Console()
+    formatter = OutputFormatter()
+
+    try:
+        service = AdminService(profile=profile)
+
+        with SpinnerProgressTracker().track_spinner(
+            f"Fetching available roles for organization {organization_rid}..."
+        ):
+            result = service.list_available_roles(
+                organization_rid, page_size=page_size, page_token=page_token
+            )
+
+        if output_file:
+            formatter.save_to_file(result, output_file, output_format)
+            console.print(f"Results saved to {output_file}")
+        else:
+            formatter.display(result, output_format)
+
+    except Exception as e:
+        console.print(f"[red]Error:[/red] {e}")
+        raise typer.Exit(code=1)
+
+
+# Marking Management Commands
+@marking_app.command("list")
+def list_markings(
+    profile: Optional[str] = typer.Option(
+        None, "--profile", help="Auth profile to use"
+    ),
+    output_format: str = typer.Option(
+        "table", "--format", help="Output format (table, json, csv)"
+    ),
+    output_file: Optional[Path] = typer.Option(
+        None, "--output", help="Save results to file"
+    ),
+    page_size: Optional[int] = typer.Option(
+        None, "--page-size", help="Number of markings per page"
+    ),
+    page_token: Optional[str] = typer.Option(
+        None, "--page-token", help="Pagination token from previous response"
+    ),
+) -> None:
+    """List all markings."""
+    console = Console()
+    formatter = OutputFormatter()
+
+    try:
+        service = AdminService(profile=profile)
+
+        with SpinnerProgressTracker().track_spinner("Fetching markings..."):
+            result = service.list_markings(page_size=page_size, page_token=page_token)
+
+        if output_file:
+            formatter.save_to_file(result, output_file, output_format)
+            console.print(f"Results saved to {output_file}")
+        else:
+            formatter.display(result, output_format)
+
+    except Exception as e:
+        console.print(f"[red]Error:[/red] {e}")
+        raise typer.Exit(code=1)
+
+
+@marking_app.command("get")
+def get_marking(
+    marking_id: str = typer.Argument(..., help="Marking ID"),
+    profile: Optional[str] = typer.Option(
+        None, "--profile", help="Auth profile to use"
+    ),
+    output_format: str = typer.Option(
+        "table", "--format", help="Output format (table, json, csv)"
+    ),
+    output_file: Optional[Path] = typer.Option(
+        None, "--output", help="Save results to file"
+    ),
+) -> None:
+    """Get information about a specific marking."""
+    console = Console()
+    formatter = OutputFormatter()
+
+    try:
+        service = AdminService(profile=profile)
+
+        with SpinnerProgressTracker().track_spinner(
+            f"Fetching marking {marking_id}..."
+        ):
+            result = service.get_marking(marking_id)
+
+        if output_file:
+            formatter.save_to_file(result, output_file, output_format)
+            console.print(f"Results saved to {output_file}")
+        else:
+            formatter.display(result, output_format)
+
+    except Exception as e:
+        console.print(f"[red]Error:[/red] {e}")
+        raise typer.Exit(code=1)
+
+
+@marking_app.command("batch-get")
+def batch_get_markings(
+    marking_ids: List[str] = typer.Argument(
+        ..., help="Marking IDs (space-separated, max 500)"
+    ),
+    profile: Optional[str] = typer.Option(
+        None, "--profile", help="Auth profile to use"
+    ),
+    output_format: str = typer.Option(
+        "table", "--format", help="Output format (table, json, csv)"
+    ),
+    output_file: Optional[Path] = typer.Option(
+        None, "--output", help="Save results to file"
+    ),
+) -> None:
+    """Batch retrieve multiple markings (max 500)."""
+    console = Console()
+    formatter = OutputFormatter()
+
+    try:
+        service = AdminService(profile=profile)
+
+        with SpinnerProgressTracker().track_spinner(
+            f"Fetching {len(marking_ids)} markings..."
+        ):
+            result = service.get_batch_markings(marking_ids)
+
+        if output_file:
+            formatter.save_to_file(result, output_file, output_format)
+            console.print(f"Results saved to {output_file}")
+        else:
+            formatter.display(result, output_format)
+
+    except ValueError as e:
+        console.print(f"[red]Error:[/red] {e}")
+        raise typer.Exit(code=1)
+    except Exception as e:
+        console.print(f"[red]Error:[/red] {e}")
+        raise typer.Exit(code=1)
+
+
+@marking_app.command("create")
+def create_marking(
+    name: str = typer.Argument(..., help="Marking name"),
+    profile: Optional[str] = typer.Option(
+        None, "--profile", help="Auth profile to use"
+    ),
+    description: Optional[str] = typer.Option(
+        None, "--description", help="Marking description"
+    ),
+    category_id: Optional[str] = typer.Option(
+        None, "--category-id", help="Category ID for the marking"
+    ),
+    output_format: str = typer.Option(
+        "table", "--format", help="Output format (table, json, csv)"
+    ),
+    output_file: Optional[Path] = typer.Option(
+        None, "--output", help="Save results to file"
+    ),
+) -> None:
+    """Create a new marking."""
+    console = Console()
+    formatter = OutputFormatter()
+
+    try:
+        service = AdminService(profile=profile)
+
+        with SpinnerProgressTracker().track_spinner(f"Creating marking '{name}'..."):
+            result = service.create_marking(
+                name=name, description=description, category_id=category_id
+            )
+
+        if output_file:
+            formatter.save_to_file(result, output_file, output_format)
+            console.print(f"Results saved to {output_file}")
+        else:
+            formatter.display(result, output_format)
+            console.print(f"[green]Marking '{name}' created successfully[/green]")
+
+    except Exception as e:
+        console.print(f"[red]Error:[/red] {e}")
+        raise typer.Exit(code=1)
+
+
+@marking_app.command("replace")
+def replace_marking(
+    marking_id: str = typer.Argument(..., help="Marking ID"),
+    name: str = typer.Argument(..., help="New marking name"),
+    profile: Optional[str] = typer.Option(
+        None, "--profile", help="Auth profile to use"
+    ),
+    description: Optional[str] = typer.Option(
+        None, "--description", help="New marking description"
+    ),
+    output_format: str = typer.Option(
+        "table", "--format", help="Output format (table, json, csv)"
+    ),
+    output_file: Optional[Path] = typer.Option(
+        None, "--output", help="Save results to file"
+    ),
+    confirm: bool = typer.Option(False, "--confirm", help="Skip confirmation prompt"),
+) -> None:
+    """Replace/update an existing marking."""
+    console = Console()
+    formatter = OutputFormatter()
+
+    if not confirm:
+        user_confirm = typer.confirm(
+            f"Are you sure you want to replace marking {marking_id}?"
+        )
+        if not user_confirm:
+            console.print("Operation cancelled.")
+            return
+
+    try:
+        service = AdminService(profile=profile)
+
+        with SpinnerProgressTracker().track_spinner(
+            f"Replacing marking {marking_id}..."
+        ):
+            result = service.replace_marking(
+                marking_id=marking_id, name=name, description=description
+            )
+
+        if output_file:
+            formatter.save_to_file(result, output_file, output_format)
+            console.print(f"Results saved to {output_file}")
+        else:
+            formatter.display(result, output_format)
+            console.print(
+                f"[green]Marking '{marking_id}' replaced successfully[/green]"
+            )
+
+    except Exception as e:
+        console.print(f"[red]Error:[/red] {e}")
+        raise typer.Exit(code=1)