Skip to main content
Version: 1.27 (Current)

Create Role

Creates a new role in the current portal.

Parameter Reference

ParameterDescriptionSupports TokensDefault
Role NameThe name of the role that will be created. Can contain Tokens.NoNone
Role DescriptionThe description of the role that will be created. Can contain Tokens.NoNone
Role Group IdentifierThe identifier of the group that will be assigned to the role. You can use a group name or a group ID, it defaults to the id that represents no role group assigned (-1) if nothing is provided. Can contain Tokens.NoNone
Role StatusThe status of the role that will be created. If you use an expression, the values accepted are -1 (Pending), 0 (Disabled), 1 (Approved). Can contain Tokens.NoNone
Add to existing usersAdd this newly created role to existing users. A value of "true" or "false" should be provided, it defaults to false if no input is received. Can contain Tokens.NoNone
Auto AssignAssign the newly created role to all users that will register on the portal. A value of "true" or "false" should be provided, it defaults to false if no input is received. Can contain Tokens.NoNone
Is PublicIs a public role. A value of "true" or "false" should be provided, it defaults to false if no input is received. Can contain Tokens.NoNone
Output Token NameProvide a token to save the Role Id in.NoNone