> For the complete documentation index, see [llms.txt](https://docs.devolutions.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.devolutions.net/powershell-universal/powershell-commands/new-psurole.md). # New-PSURole ## SYNOPSIS Defines a new role within PowerShell Universal. ## SYNTAX ### Policy (Default) ``` New-PSURole -Name [-Description ] [-Policy ] [-Disabled] [-DefaultRoute ] [-Roles ] [-Permissions ] [-Priority ] [-ComputerName ] [-AppToken ] [-Credential ] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies] [] ``` ### Claim ``` New-PSURole -Name [-Description ] -ClaimType -ClaimValue [-Disabled] [-DefaultRoute ] [-Roles ] [-Permissions ] [-Priority ] [-ComputerName ] [-AppToken ] [-Credential ] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies] [] ``` ## DESCRIPTION Defines a new role within PowerShell Universal. Roles are used to define authorization within the PowerShell Universal platform. Roles can be assigned statically to an Identity or can be assigned by the -Policy script block. The policy script block receives a $User parameter that contains the identity information and claims that an identity has been granted during authentication. Policy script blocks need to return either $true or $false to determine whether this particular identity should be provided the role. Roles configurations are stored in .universal/roles.ps1 You can also use this cmdlet to create roles through the REST API. ## EXAMPLES ### Example 1 ``` New-PSURole -Name 'Developers' -Policy { param($User) $User.Claims.HasClaim('myGroup') } ``` Creates a new role with a policy defined that checks to see if the user's claim contains the 'myGroup' claim. ## PARAMETERS ### -AppToken The AppToken that is used for calling the PowerShell Universal Management API. You can also call Connect-PSUServer before calling this cmdlet to set the AppToken for the entire session. ```yaml Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -ComputerName Specifies the computer name or URL that should be called when accessing the PowerShell Universal Management API. You can also use Connect-PSUServer before calling this cmdlet to set the computer name for the entire session. ```yaml Type: String Parameter Sets: (All) Aliases: Uri Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Description The description of this role to show within the Admin Console. ```yaml Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Name The name of this role. The name is used for both display and for assigning resources like APIs and dashboards. ```yaml Type: String Parameter Sets: (All) Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Policy The policy script block to execute when determining whether to assign this role. ```yaml Type: ScriptBlock Parameter Sets: Policy Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -UseDefaultCredentials Use default credentials when connecting to the management API ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Integrated Executes the command internally rather than using the Management API. Only works when running script from within PowerShell Universal. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -ClaimType The claim type to map for this role. See Role to Claim mapping in our documentation. ```yaml Type: String Parameter Sets: Claim Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -ClaimValue The claim value to map for this role. See Role to Claim mapping in our documentation. ```yaml Type: String Parameter Sets: Claim Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Disabled Whether the role is disabled. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -DefaultRoute The default URL to forward users in this role to. ```yaml Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Roles Child roles that should be assigned to the users that are assigned this role. ```yaml Type: String[] Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Credential Credentials to login to the PowerShell Universal Management API. ```yaml Type: PSCredential Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Permissions Permissions assigned to users that are granted this role. ```yaml Type: String[] Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -TrustCertificate Whether the cmdlet should ignore certificate issues. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Priority The priority of this role. Determines which redirect to use when multiple roles are assigned to a user. ```yaml Type: Int32 Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Cookies Reuses and persists authentication cookies for the current PowerShell session. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -Verbose, -WarningAction, -WarningVariable, and -ProgressAction. For more information, see [about\_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None ## OUTPUTS ### System.Object ## NOTES ## RELATED LINKS --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.devolutions.net/powershell-universal/powershell-commands/new-psurole.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.