Skip to main content
Version: 13 - TBD

IdentityRole

class flow_api.identity_role.IdentityRole(select=None, cls=None, init=None, by='id', allow_normal=True, allow_deleted=False, commit=False, grants_apply=<class 'flow_api.system.NotSet'>, identity_id=<class 'flow_api.system.NotSet'>, propagate=<class 'flow_api.system.NotSet'>, role_id=<class 'flow_api.system.NotSet'>, debug=False)

Base class: Row

Mapping an identity to a role.

Parameters

NameTypeDescription
allow_deletedbool
allow_normalbool
bystr
clsOptional
commitbool
debugboolif set, the content of the data being written will be logged.
grants_applyUnionWhether this role assignment contributes its ALLOW (grant) permissions to the identity. Defaults True for directly-assigned roles. Set False on the deny-only assignment copies that _apply_roles propagates into created (execution) identities for a parent role whose grants do NOT propagate (propagate=False) but which carries DENY permissions: such a copy contributes ONLY its DENY permissions in auth_get_permissions, so a DENY is inescapable across delegation while grants still attenuate with propagate. See operator-task-flow-api-read-deny-bypass-honour-role-permission.
identity_idUnionReference to the identity the role is mapped to.
initOptional
propagateUnionA flag to control if this role is propagated to other records created by the identity.
role_idUnionReference to the role the identity is mapped to.
selectOptional

Constants

RESOURCE = identity_role

Methods

clone

delete

duplicate

exists

export

get

get_dict

identity

restore

role

save