authorisation

authorisation

authorisation

User authorisation

Metadata

Instantiating

checkInheritedPermission()

DEPRICATED... USE checkPermission instead.

Arguments

Name Type Required Default Options Description
None

checkPermission()

Checks whether you have permission to perform an action on an object. Note: A positive permission from one group overides a negative permission from another group, i.e. they are permissive(heh!).

Arguments

Name Type Required Default Options Description
permissionName String Yes
reference String No
objectID String No
lPolicyGroupIDs String No

collateObjectPermissions()

Returns a struct containing the actual, inherited, and tranformed rights for a each role on a given object

Arguments

Name Type Required Default Options Description
objectid uuid Yes The object to query
typename String No dmNavigation Depreciated. Type is now retrieved via findType.

copyPolicyGroup()

Copys an existing policy group in the datastore

Arguments

Name Type Required Default Options Description
stForm struct Yes Contains a sourcePolicyGroupID and a name value

createPermission()

Creates a new permission in the datastore

Arguments

Name Type Required Default Options Description
permissionID String No -1 Note that permissionID is only handed in during installtation of farcry
permissionName String Yes
permissionType String Yes
permissionNotes String No

createPermissionBarnacle()

Creates a permission for a daemon security user context.Only unique permissions will be accepted.

Arguments

Name Type Required Default Options Description
reference String Yes
status String Yes
policygroupID String No
policygroupname String No
permissionID String No
permissionName String No
permissionType String No

createPolicyGroup()

Creates a new policy group in the datastore

Arguments

Name Type Required Default Options Description
policyGroupName string Yes
policyGroupNotes string No
policyGroupID numeric No

createPolicyGroupMapping()

Creates a new policy group mapping

Arguments

Name Type Required Default Options Description
groupname string Yes
userdirectory string Yes
policyGroupId uuid Yes

deletePermission()

Delets a permission from the datastore

Arguments

Name Type Required Default Options Description
permissionID uuid Yes

deletePermissionBarnacle()

Deletes a permission for a daemon security user context

Arguments

Name Type Required Default Options Description
objectid UUID Yes

deletePolicyGroup()

Deletes a policy group from the data store.

Arguments

Name Type Required Default Options Description
PolicyGroupName string No
PolicyGroupID string No

deletePolicyGroupMapping()

Arguments

Name Type Required Default Options Description
groupname string Yes The user directory group
userdirectory string Yes The user directory the group is from
policyGroupID uuid Yes The policy to update

deletePolicyStore()

Hmmm this does the same thing as delete policyGroup

Arguments

Name Type Required Default Options Description
policyGroupID String Yes

fListUsersByPermssion()

returns list of user objectids for a particular permission

Arguments

Name Type Required Default Options Description
permissionName string No
permissionID string No

getAllPermissions()

Returns an array of property structs

Arguments

Name Type Required Default Options Description
permissionType String No

getAllPolicyGroups()

Gets all policy groups.

Arguments

Name Type Required Default Options Description
None

getMultiplePolicyGroupMappings()

Retrieves all group mappings in the form of an array of groupName+userdirectory structures. Filtered by lUserdirectory,policygroupname/policygroupid.

Arguments

Name Type Required Default Options Description
userdirectory String No
lGroupNames String No
policyGroupId string No

getObjectPermission()

Arguments

Name Type Required Default Options Description
reference String No
objectID String No
lrefs String No
bUseCache String No 1

getPermission()

Arguments

Name Type Required Default Options Description
permissionID String No
permissionName string No
permissionType string No

getPolicyGroup()

Arguments

Name Type Required Default Options Description
policyGroupName string No
policyGroupID string No

getPolicyGroupMappings()

Arguments

Name Type Required Default Options Description
lGroupNames string Yes List of groups to get mappings for
userDirectory string Yes User directory the groups are part of

getPolicyGroupUsers()

Retrieve list of usernames that are members of a specified Policy Group

Arguments

Name Type Required Default Options Description
lPolicyGroupIds String No

getPolicyStore()

Arguments

Name Type Required Default Options Description
None

importPolicyGroup()

exports the policy group as a wddx file

Arguments

Name Type Required Default Options Description
stForm struct Yes form variables passed form editform

reInitPermissionsCache()

Refreshes server permissions cache from existing database permissions

Arguments

Name Type Required Default Options Description
None

updateObjectPermissionCache()

Arguments

Name Type Required Default Options Description
objectid String No
reference String No
bRevalidateCache String No 1

updatePermission()

Arguments

Name Type Required Default Options Description
permissionID String Yes
permissionName String Yes
permissionType String Yes
permissionNotes String No

updatePolicyGroup()

Arguments

Name Type Required Default Options Description
policyGroupID String Yes
PolicyGroupName String Yes
PolicyGroupNotes String No