role-based.md

Role-Based

{% hint style="info" %} Not available in Community Edition. {% endhint %}

You can setup roll-based authorization by specifying the role a user is granted during login with New-UDAuthenticationResult.

$FormLogin = New-UDAuthenticationMethod -Endpoint {
    param([PSCredential]$Credentials)

    if ($Credentials.UserName -eq "Adam" -and $Credentials.GetNetworkCredential().Password -eq "SuperSecretPassword") {
        New-UDAuthenticationResult -Success -UserName "Adam" -Role "Administrator"
    }

    New-UDAuthenticationResult -ErrorMessage "You aren't Adam!!!"
}

You can then permit access to pages and REST API endpoints by assigning roles to them.

New-UDPage -Title 'Settings Page' -AuthorizedRole "Administrator" -Content {
    "Only available to admins"
}

You can also specify multiple roles per page or endpoint.

New-UDPage -Title 'Home Page' -AuthorizedRole @("Administrator", "User") -Content {
    "Available to everyone"
}