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? canDelete? canEdit? createdAt createdBy? description fullUser? id lastUpdatedAt level? links name permissions? tenantId type updatedBy? userEntitlementType?

Properties

assignedScopes?: string[]

Selection of scopes added to this Role

canDelete?: boolean

Indicate if role can be deleted

canEdit?: boolean

Indicate if role can be edited by tenant (Shown as Profile in MC)

createdAt: string

The timestamp for when the role was created.

createdBy?: string

Id of user that created role

description: string

Descriptive text for the role.

fullUser?: boolean

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

id: string

The unique identifier for the role.

lastUpdatedAt: string

The timestamp for when the role was last updated.

level?: "admin" | "user"

The level of access associated to the role.

links: { self: { href: string } }

Contains links for the role.

name: string

The name of the role.

permissions?: string[]

An array of permissions associated with the role.

tenantId: string

The tenant unique identifier associated with the given Role.

type: "default" | "custom"

The type of role.

updatedBy?: string

Id of user that last updated this role

userEntitlementType?: string

Indicate whether this role will trigger promotion of a user from a basic to a full user on tenants with a capacity-based subscription. Does not apply to tenants with a user-based subscription. Returns fullUser if it will trigger promotion.

Settings

Member Visibility

On This Page

Properties