@deep/nest-kit
    Preparing search index...

    Class CreateRoleOptions

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    description?: MaybeNull<string>

    Role description

    `The "Editor" role is a user role within an application,
    granting users assigned to this role the ability to create, modify, and manage content.`
    id?: string
    organizationId?: MaybeNull<string>

    The organizationId property stores the unique identifier of the organization to which the role belongs.

    permissionGroups?: MaybeNull<string[]>

    The permissionGroups property is an array of permission group IDs associated with a role. Permission groups provide a way to bundle permissions together for easier management.

    permissions?: MaybeNull<string[]>

    The permissions property is an array of strings that holds a list of permissions associated with the role. These permissions define the specific actions and access levels that the role grants to its users, enabling fine-grained control over what users with this role can do within the application.

    productId?: MaybeNull<string>

    The productId property stores the unique identifier of the product to which the role belongs.

    title: string

    Role title

    "Editor"
    
    type: RoleType

    The type property represents the category of the role, which can be one of the following: SYSTEM, ORGANIZATION, BRAND, STUDIO, PASSPORT_TYPE REVIEW or ORGANIZATION_GROUP. This classification helps to differentiate roles based on their scope and usage within the application.