@makehq/sdk
    Preparing search index...

    Type Alias Role

    Represents a role in Make. Roles define a set of permissions and can be assigned to users at the organization or team level. In addition to built-in system roles, an organization may have custom roles when the customRoles license feature and Roleman are enabled.

    type Role = {
        category: "organization" | "team";
        description: string | null;
        id: number;
        identifier?: string;
        managementType: "system_locked" | "admin_managed" | "custom_managed";
        name: string;
        organizationId?: number | null;
        permissions: string[];
        subsidiary?: boolean;
    }
    Index

    Properties

    category description id identifier? managementType name organizationId? permissions subsidiary?

    Properties

    category: "organization" | "team"

    Whether the role applies to an organization or a team

    description: string | null

    Description of the role

    id: number

    Unique identifier of the role

    identifier?: string

    Machine-readable identifier of a built-in system role; absent for custom roles

    managementType: "system_locked" | "admin_managed" | "custom_managed"

    Whether the role is a built-in locked role, a built-in admin-managed role, or a custom-managed one

    name: string

    Name of the role

    organizationId?: number | null

    ID of the organization that owns the role; only present for custom roles, and only returned by get()

    permissions: string[]

    Names of the permissions granted by the role

    subsidiary?: boolean

    Whether the role is assignable by non-admin users

    Settings

    Member Visibility

    On This Page

    Properties