Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Working with permissions files

You can create a custom permissions file or update an existing permissions file using your preferred text editor. A permissions file typically takes the following format:

#import file_to_import

[groups]
group_definitions
				
[aliases]
alias_definitions
				
[permissions]
user_permissions
			

The following sections explain how to populate the sections when updating or creating a permissions file.

Import a permissions file

The imports section is typically the first section of the permissions file. You can use this section to reference and include existing permissions files. You can also use it to incorporate previously defined NICE DCV permissions into your permissions file.

A permissions file can include multiple imports. An imported permissions file might import other permissions files.

Example

The following statement imports a permissions file named dcv-permissions.file using an absolute path. It's located in the NICE DCV installation folder on a Windows NICE DCV server.

#import c:\Program Files\NICE\DCV\dcv-permissions.file

Create groups

You can use [groups] section of the permissions file to define user groups for users that have similar use cases or permissions requirements. Groups can be assigned specific permissions. Permissions assigned to a group apply to all of the users that are included in the group.

To create groups in your permissions file, you must first add the groups section heading to the file.

[groups]

You can then create your groups under the section heading. To create a group, provide the group name, and then specify the group members in a comma-separated list. Group members can be individual users, other groups, and operating system user groups.

group_name=member_1, member_2, member_3

To add a user to a group

Specify the user name.

group_name=user_1, user:user_2, domain_name\user_3

To add an existing group to a group

Specify the group name prefixed with group:

group_name=group:group_1, group:group_2

To add an operating system user group to a group (Linux NICE DCV servers only)

Specify the group's name prefixed with osgroup:

group_name=osgroup:os_group_1, osgroup:os_group2

Example

The following example adds the groups section heading and creates a group that's named my-group. This group includes individual users. They're named john and jane. One of them is an existing group that's named observers. The other is an operating system user group that's named guests:

[groups]
my-group=john, user:jane, group:observers, osgroup:guests

Create aliases

You can use the [aliases] section of the permissions file to create sets of NICE DCV features. After an alias was defined, you can grant or deny groups or individual users permissions to use it. Granting or denying permissions to an alias grants or denies permissions to all of the features that are included in it.

To create aliases in your permissions file, you must first add the aliases section heading to the file.

[aliases]

You can then create your aliases under the section heading. To create an alias, provide the alias name, and then specify the alias members in a comma-separated list. Alias members can be individual NICE DCV features or other aliases.

alias_name=member_1, member_2, member_3

Example

The following example adds the aliases section heading and creates an alias that's named file-management. It includes the file-upload and file-download features and an existing alias that's named clipboard-management.

[aliases]
file-management=file-upload, file-download, clipboard-management

Add permissions

The [permissions] section of the permissions file lets you control user and group access to specific features or aliases.

To add permissions to your permissions file, first add the permissions section heading to the file.

[permissions]

You can then add your permissions under the section heading. To add a permission, specify the actor that it governs, the rule to be applied, and the features that it applies to.

actor rule features

The actor can be a user, a group, or an operating system group. Groups must be prefixed with group:. Operating system groups must be prefixed with osgroup:. NICE DCV includes a built-in %owner% reference that can be used to refer to the session owner. It can also be used to refer to a built-in %any% reference that can be used to refer to any user.

The following rules can be used in permissions statements:

The features can include individual NICE DCV features, aliases, or a combination of both. The list of features must be separated by a space. NICE DCV includes a built-in builtin alias that includes all of the NICE DCV features.

The following features can be referenced in the permissions file:

Example

The following example adds the permissions section heading and adds four permissions. The first permission grants a user named john access to the display, file-upload, and file-download features. The second permission denies the observers group access to the audio-in and audio-out features, and the clipboard-management feature alias. The third permission grants the guests operating system group access to the clipboard-management and file-management aliases. The fourth permission grants the session owner access to all features.

[permissions]
john allow display file-upload file-download			
group:observers deny audio-in audio-out clipboard-management
osgroup:guests allow clipboard-management file-management
%owner% allow builtin