> For the complete documentation index, see [llms.txt](https://docs.lithnet.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.lithnet.io/ams/help-and-support/powershellmodule/set-amsroleauthorizationrule.md). # Set-AmsRoleAuthorizationRule ## SYNOPSIS Configures a role authorization rule ## SYNTAX ``` Set-AmsRoleAuthorizationRule [-Id] [-Name ] [-AddPrincipalsAllowedJit ] [-RemovePrincipalsAllowedJit ] [-AddPrincipalsDeniedJit ] [-RemovePrincipalsDeniedJit ] [-GroupName ] [-MaximumAccessDuration ] [-DefaultAccessDuration ] [-AllowExtension ] [-Description ] [-RuleExpiryDate ] [-Enabled ] [-Notes ] [-UserRequestReasonRequirement ] [-NotificationChannelsSuccess ] [-NotificationChannelsFailure ] [-SiteName ] [-DomainControllerName ] [] ``` ## DESCRIPTION This cmdlet allows you to change properties on role authorization rules ## EXAMPLES ### Example 1 ```powershell PS C:\> Set-AmsRoleAuthorizationRule -Id 'a984d40c-8b22-4009-83ac-f38b7b341cc4' -Name "My new role name" ``` Renames a role ### Example 2 ```powershell PS C:\> Set-AmsRoleAuthorizationRule -Id 'a984d40c-8b22-4009-83ac-f38b7b341cc4' -AddPrincipalsAllowedJit "DOMAIN\user1" ``` Adds \`Domain\user1\` to the list of users who are allowed to access this role ### Example 3 ```powershell PS C:\> Get-AmsRoleAuthorizationRule -Name "My role" | Set-AmsRoleAuthorizationRule -AddPrincipalsDeniedJit "DOMAIN\user1" ``` Get a rule by its name, and adds \`Domain\user1\` to the list of users who are denied to access this role ### Example 4 ```powershell PS C:\> Get-AmsRoleAuthorizationRule -Name "My role" | Set-AmsRoleAuthorizationRule -Enabled:$false ``` Get a rule by its name, and disables it ## PARAMETERS ### -AddPrincipalsAllowedJit A list of usernames or SIDs to add to the list of users who are allowed to access this role ```yaml Type: Object[] Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -AddPrincipalsDeniedJit A list of usernames or SIDs to add to the list of users who are not allowed to access this role ```yaml Type: Object[] Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -AllowExtension Specifies if the user is allowed to extend their access request before it expires ```yaml Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -DefaultAccessDuration The amount of time the user is offered to access this role by default. This value cannot be greater than the value defined in MaximumAccessDuration ```yaml Type: TimeSpan Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Description A description of the role, as shown to end users ```yaml Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Enabled Indicates if the rule should be enabled ```yaml Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -GroupName The name of the group that users will be added to when granted access to this role ```yaml Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Id The ID of the role to edit ```yaml Type: String Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` ### -MaximumAccessDuration The maximum amount of time the user can request access to this role ```yaml Type: TimeSpan Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Name The name of the role, as shown to end users ```yaml Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Notes A custom field to store notes, only visible to AMS administrators ```yaml Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -NotificationChannelsFailure A list of channel IDs that should be notified when a user is denied access to this role ```yaml Type: String[] Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -NotificationChannelsSuccess A list of channel IDs that should be notified when a user is granted access to this role ```yaml Type: String[] Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -RemovePrincipalsAllowedJit A list of usernames or SIDs to remove from the list of users who are allowed to access this role ```yaml Type: Object[] Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -RemovePrincipalsDeniedJit A list of usernames or SIDs to remove from the list of users who are not allowed to access this role ```yaml Type: Object[] Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -RuleExpiryDate A date and time when this rule will expire, expressed in local time ```yaml Type: DateTime Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -UserRequestReasonRequirement Specifies if the user must provide a reason for the request, if they can optionally provide a reason, or are not prompted at all for a reason ```yaml Type: AuditReasonFieldState Parameter Sets: (All) Aliases: Accepted values: Hidden, Optional, Required Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -DomainControllerName The name of a domain controller to use when performing the JIT operation against ```yaml Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -SiteName The name of the site to use when trying to find a domain controller to perform the JIT operation against ```yaml Type: String 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, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about\_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### System.String ## OUTPUTS ### Lithnet.AccessManager.PowerShell.RoleAuthorizationRulePSObject ## NOTES Use of this cmdlet requires an Enterprise Edition license. ## 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.lithnet.io/ams/help-and-support/powershellmodule/set-amsroleauthorizationrule.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.