Getting Started

Getting Started with PIMActivation

This guide will help you install and configure the PIMActivation PowerShell module for the first time.

📋 Prerequisites

Before installing PIMActivation, ensure you have:

Required Software

• Windows 10/11 or Windows Server 2016+
• PowerShell 7+ (Download here)
• Internet connectivity for module installation and API access

Required Permissions

• Entra ID Permissions:
  • Eligible for at least one PIM role
  • Permission to read directory information
  • Permission to activate PIM roles

🚀 Installation

From PowerShell Gallery (Recommended)

# Install for current user
Install-Module -Name PIMActivation -Scope CurrentUser -Force

# Or install system-wide (requires admin)
Install-Module -Name PIMActivation -Scope AllUsers -Force

From GitHub

# Clone the repository
git clone https://github.com/Noble-Effeciency13/PIMActivation.git
cd PIMActivation

# Import the module
Import-Module .\PIMActivation.psd1 -Force

🔧 First Run

Step 1: Import the Module

Import-Module PIMActivation

Step 2: Launch the Application

Start-PIMActivation

Step 3: Initial Authentication

1. A browser window will open for authentication
2. Sign in with your Entra ID account
3. Complete any MFA requirements
4. Accept permission consent if prompted

Step 4: Understanding the Interface

The main window consists of three sections:

1. Eligible Roles (Left Panel)

   • Shows all roles you can activate
   • Displays role name, scope, and policy requirements
   • Use checkboxes to select multiple roles

2. Active Roles (Right Panel)

   • Shows currently active roles
   • Displays expiration times
   • Allows deactivation of roles

3. Control Panel (Bottom)

   • Duration selector
   • Justification field
   • Ticket information (if required)
   • Action buttons

✅ Verification

To verify successful installation:

# Check module is installed
Get-Module -Name PIMActivation -ListAvailable

# Check module can be imported
Import-Module PIMActivation

# Get module information
Get-Module PIMActivation | Select-Object Name, Version, Description

🆘 Getting Help

# Get help for the module
Get-Help Start-PIMActivation -Full

# View examples
Get-Help Start-PIMActivation -Examples

# Read about documentation
Get-Help about_PIMActivation

📝 Next Steps

• Read the Features Guide to understand all capabilities
• Check Troubleshooting if you encounter issues
• Explore Advanced Usage for automation scenarios

---

← Back to Home | Features Guide →