Set-R1FIDUserRole

Set-R1FIDUserRole

SYNOPSIS

Sets the roles associated with a FID user.

SYNTAX

Set-R1FIDUserRole [-username] <String> [-roles] <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Replaces the complete list of roles associated with a FID user. Any role not included in the supplied list is removed from the user.

The roles are set by updating the user, which is what the control panel does. The properties not being changed keep their current values.

EXAMPLES

Example 1

Set-R1FIDUserRole -username john_smith -roles admin, dev

Associates the user with the admin and dev roles.

Example 2

Set-R1FIDUserRole -username john_smith -roles @()

Removes every role from the user.

PARAMETERS

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-roles

The complete list of role names to associate with the user. Any role not included is removed from the user.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-username

The username of the user whose roles are being set.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
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.

INPUTS

System.String

System.String[]

OUTPUTS

System.Void

NOTES

The API also defines an endpoint dedicated to a user’s roles, which it marks as deprecated. A RadiantOne 8.5.3 deployment answers 404 for it.

RELATED LINKS