Skip to main content

Interface: SystemRoleCanonicalizationResponse

Defined in: packages/sdk/src/types/generated/member_role.ts:166

What canonicalizing one platform-seeded role needs (or did).

Properties

adopted?

optional adopted: boolean

Defined in: packages/sdk/src/types/generated/member_role.ts:175

A keyless role that already is this seeded role (written differently) will be/was adopted by setting its system_key.


blockedByRoleName?

optional blockedByRoleName: string | null

Defined in: packages/sdk/src/types/generated/member_role.ts:181

Set when a different role still holds the canonical name; that role must be merged into this one before the rename can happen.


canonicalName

canonicalName: string

Defined in: packages/sdk/src/types/generated/member_role.ts:168


created?

optional created: boolean

Defined in: packages/sdk/src/types/generated/member_role.ts:173

The role will be/was created.


currentName?

optional currentName: string | null

Defined in: packages/sdk/src/types/generated/member_role.ts:171


renamed?

optional renamed: boolean

Defined in: packages/sdk/src/types/generated/member_role.ts:177

The name will be/was set to the canonical spelling.


roleId?

optional roleId: number | null

Defined in: packages/sdk/src/types/generated/member_role.ts:170

Null while the role does not exist yet.


scopesAdded?

optional scopesAdded: string[]

Defined in: packages/sdk/src/types/generated/member_role.ts:178


scopesRemoved?

optional scopesRemoved: string[]

Defined in: packages/sdk/src/types/generated/member_role.ts:179


systemKey

systemKey: string

Defined in: packages/sdk/src/types/generated/member_role.ts:167