Skip to main content

Set-IMAlbumUser

SYNOPSIS​

Updates user roles in an Immich album

SYNTAX​

Set-IMAlbumUser [[-Session] <ImmichSession>] [-AlbumId] <String> [-UserId] <String[]> [-Role] <String>
 [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION​

Changes the role of one or more users in an Immich album. Users can be promoted or demoted between editor (full access) and viewer (read-only) roles.

EXAMPLES​

EXAMPLE 1​

Set-IMAlbumUser -AlbumId 'album-uuid' -UserId 'user-uuid' -Role 'editor'

Promotes a user to editor role in the specified album.

EXAMPLE 2​

@('user1-uuid', 'user2-uuid') | Set-IMAlbumUser -AlbumId 'album-uuid' -Role 'viewer'

Changes multiple users to viewer role via pipeline.

EXAMPLE 3​

Get-IMAlbum -AlbumId 'album-uuid' | Get-IMAlbumUsers | Where-Object {$_.role -eq 'editor'} | Set-IMAlbumUser -AlbumId 'album-uuid' -Role 'viewer'

Demotes all current editors to viewers in the album.

PARAMETERS​

-Session​

Optionally define an Immich session object to use. This is useful when you are connected to more than one Immich instance.

Type: ImmichSession
Parameter Sets: (All)
Aliases:

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

-AlbumId​

The UUID of the album to update user roles in.

Type: String
Parameter Sets: (All)
Aliases:

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

-UserId​

The UUID(s) of the user(s) whose roles should be updated. Accepts pipeline input and multiple values.

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

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

-Role​

The new role to assign to the user(s). Valid values are 'editor' (can modify album) or 'viewer' (read-only access).

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 4
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

-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

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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.

INPUTS​

OUTPUTS​

NOTES​

This cmdlet supports ShouldProcess and will prompt for confirmation before changing user roles.

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github