Role Commands

• get-role
• delete-role
• list-roles
• new-role
• set-role

get-role

Retrieves details about the specified DNN role

Parameter
--id

• id
• Type: Integer
• Required: Yes
• Description: The ID of the security role. This value is required. However, if you pass the id as the first argument after the command, you do not need to explicitly use the --id flag.

Example usage: "get-role 11" - Gets info about the security role that has the id of 11

---

delete-role

Permanently deletes the given DNN security role

Parameter
--id

• id
• Type: Integer
• Required: Yes
• Description: The ID of the security role. This value is required. However, if you pass the id as the first argument after the command, you do not need to explicitly use the --id flag.

Example usage: "delete-role 11" - Permanently deletes the security role that has the id of 11

Note - This is a permanent action and cannot be undone

---

list-roles

Retrieves a list of DNN Security Roles for the portal

---

new-role

Creates a new DNN Security Role

Parameters
--autoassign
--description
--name
--public

• autoassign

• Type: Boolean

• Required: No

• Description: When true, this role will be automatically assigned to users of the site including existing users.

• description

• Type: String

• Required: No

• Description: A description of the role.

• id

• Type: Integer

• Required: No

• Description: The ID of the security role. This value is required. However, if you pass the id as the first argument after the command, you do not need to explicitly use the --id flag.

• name

• Type: String

• Required: Yes

• Description: The name of the security role. This value is required. However, if you pass the name as the first argument after the command, you do not need to explicitly use the --name flag.

• public

• Type: Boolean

• Required: No

• Description: The name of the security role. This value is required. However, if you pass the name as the first argument after the command, you do not need to explicitly use the --name flag.

Example usage(s):

• "new-role Content Creators" - Creates a new role named "Content Creators"
• "new-role "General Public" --description "Role for all users" --public true --autoassign true" - Creates a new DNN Security role named "General Public" that is a public role which new registrants are auto-assigned to

---

set-role

Sets or updates properties of the specified DNN role

Parameters
--autoassign
--description
--id
--name
--public

• autoassign

• Type: Boolean

• Required: No

• Description: When true, this role will be automatically assigned to users of the site including existing users.

• description

• Type: String

• Required: No

• Description: A description of the role.

• id

• Type: Integer

• Required: No

• Description: The ID of the security role. This value is required. However, if you pass the id as the first argument after the command, you do not need to explicitly use the --id flag.

• name

• Type: String

• Required: Yes

• Description: The name of the security role. This value is required. However, if you pass the name as the first argument after the command, you do not need to explicitly use the --name flag.

• public

• Type: Boolean

• Required: No

• Description: The name of the security role. This value is required. However, if you pass the name as the first argument after the command, you do not need to explicitly use the --name flag.

Example usage(s):

• "set-role 10 --name "Content Creators" - Updates the role with role id 10 to have the name of "Content Creators"