Set-R1FIDRole
Set-R1FIDRole
SYNOPSIS
Updates a FID role.
SYNTAX
Set-R1FIDRole [-name] <String> [[-entryDn] <String>] [[-directoryBrowserPermission] <String>]
[[-directoryNamespacePermissions] <Hashtable>] [[-identityManagerPermission] <String>]
[[-securityPermissions] <Hashtable>] [[-classicControlPanelPermission] <Hashtable>]
[[-tasksPermission] <String>] [-settingsPermissions <Hashtable>] [-tuningPermissions <Hashtable>]
[[-globalSyncPermission] <String>] [[-observabilityPermission] <String>] [[-dashboardPermission] <String>]
[[-fileManagerPermission] <String>] [[-revokeTokenPermission] <Boolean>]
[[-dataCatalogPermissions] <Hashtable>] [[-administrationPermissions] <Hashtable>]
[[-exportImportPermissions] <Hashtable>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Updates an existing FID role.
The role is retrieved before it is updated, and the complete role is sent back with the supplied values applied over it. A permission left unspecified therefore keeps its current value.
This matters because the endpoint resets any permission absent from the request to NONE. Sending only the supplied permissions would silently clear every other permission the role holds. The control panel avoids this the same way, by sending back the whole role it retrieved. One consequence is that the command issues two requests: a GET followed by a PUT.
Because the command retrieves the resource before updating it, the account needs permission to read it as well as to change it. A role granted only the update permission fails on the retrieval.
To clear a permission, set it to NONE explicitly.
EXAMPLES
Example 1
Set-R1FIDRole -name engineering -tasksPermission EDIT -dashboardPermission VIEW
Updates the permissions held by the named role.
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
-administrationPermissions
Hashtable of administration permissions, with userManagementPermission, entryStatisticsPermission, rolesPermission, directoryManagerPermission, controlPanelConfigPermission, accessTokensPermission, licensePermission, auditLoggingPermission, featureManagementPermission, maintenanceModePermission keys.
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 15
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-classicControlPanelPermission
Hashtable describing access to the classic control panel, with enabled and assumeRole keys.
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-dashboardPermission
Permission granted over the dashboard. NONE, VIEW or EDIT.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: NONE, VIEW, EDIT
Required: False
Position: 11
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-dataCatalogPermissions
Hashtable of data catalog permissions, with dataSourcesPermission, dataSourceOverrides, templateManagementPermission, globalRelationshipsPermission and dataAssessmentPermission keys.
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 14
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-directoryBrowserPermission
Permission granted over the directory browser. NONE, VIEW or EDIT.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: NONE, VIEW, EDIT
Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-directoryNamespacePermissions
Hashtable of directory namespace permissions, with namespaceDesignPermission and directorySchemaPermission keys.
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-entryDn
The DN of the directory entry the role is associated with.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-exportImportPermissions
Hashtable of configuration export/import permissions, with exportEnabled and importEnabled keys.
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 16
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-fileManagerPermission
Permission granted over the file manager. NONE, VIEW or EDIT.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: NONE, VIEW, EDIT
Required: False
Position: 12
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-globalSyncPermission
Permission granted over global sync. NONE, VIEW or EDIT.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: NONE, VIEW, EDIT
Required: False
Position: 9
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-identityManagerPermission
Permission granted over the identity manager. NONE, VIEW or EDIT.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: NONE, VIEW, EDIT
Required: False
Position: 4
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-name
The name of the role to update.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-observabilityPermission
Permission granted over identity observability. NONE, VIEW or EDIT.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: NONE, VIEW, EDIT
Required: False
Position: 10
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-revokeTokenPermission
Whether the role permits revoking authentication tokens.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-securityPermissions
Hashtable of security permissions, with attributeEncryptionPermission, accessControlPermission, passwordPoliciesPermission keys.
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-tasksPermission
Permission granted over tasks. NONE, VIEW or EDIT.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: NONE, VIEW, EDIT
Required: False
Position: 7
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-settingsPermissions
Hashtable of settings permissions, with clientProtocolsPermission, clientCertificatePermission, tuningPermission, tokenValidatorPermission keys.
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-tuningPermissions
Hashtable of tuning permissions, with backendLimitsPermission, accessRegulationLimitsPermission, changeLogPermission, globalLimitsPermission, customLimitsPermission, globalAttributesPermission, logSettingsPermission keys.
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
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.