Type Alias Role

type Role = {
    assignedScopes?: string[];
    canDelete?: boolean;
    canEdit?: boolean;
    createdAt: string;
    createdBy?: string;
    description: string;
    fullUser?: boolean;
    id: string;
    lastUpdatedAt: string;
    level?: "admin" | "user";
    links: { self: { href: string } };
    name: string;
    permissions?: string[];
    tenantId: string;
    type: "default" | "custom";
    updatedBy?: string;
    userEntitlementType?: string;
}
Index

Properties

assignedScopes?: string[]

Selection of scopes added to this Role

canDelete?: boolean
canEdit?: boolean
createdAt: string
createdBy?: string
description: string
fullUser?: boolean

DEPRECATED. Use userEntitlementType instead for impact of roles on user entitlements with a capacity-based subscription.

id: string
lastUpdatedAt: string
level?: "admin" | "user"
links: { self: { href: string } }
name: string
permissions?: string[]
tenantId: string
type: "default" | "custom"
updatedBy?: string
userEntitlementType?: string