Interface CanIParams

Parameters for the canI recipe — a subset of EffectiveAccessClient.can's request shape, with scope derived from whether companyId is set.

interface CanIParams {
    companyId?: string;
    featureKey: string;
    moduleKey?: string;
    object?: EffectiveAccessObjectRef;
    relation?: string;
    requiredCompanyRole?: string;
    requiredPlatformRole?: string;
    requiresEligibility?: boolean;
}

Index

Properties

companyId? featureKey moduleKey? object? relation? requiredCompanyRole? requiredPlatformRole? requiresEligibility?

Properties

`Optional`companyId

companyId?: string

Omit for a global-scope check (e.g. superadministration); set for a company-scope check.

featureKey

featureKey: string

`Optional`moduleKey

moduleKey?: string

`Optional`object

object?: EffectiveAccessObjectRef

`Optional`relation

relation?: string

`Optional`requiredCompanyRole

requiredCompanyRole?: string

`Optional`requiredPlatformRole

requiredPlatformRole?: string

`Optional`requiresEligibility

requiresEligibility?: boolean