Security TurboIntegrator Functions

These functions pertain to security.

AddClient
AddClient creates a new client on the server. Changes applied through the AddClient functions do not take effect until the Metadata procedure in a process is completed. This function, like all functions that update metadata, should not be used in the Data or Epilog tabs of a process.
AddGroup
AddGroup creates a new user group on the server. Changes applied through the AddGroup function do not take effect until the Metadata procedure in a process is completed. This function, like all functions that update metadata, should not be used in the Data or Epilog tabs of a process.
AssignClientToGroup
AssignClientToGroup assigns an existing client on a server to an existing user group. This function assigns an existing client on a server to an existing user group.
AssignClientPassword
AssignClientPassword assigns a password to an existing client on a server. AssignClientPassword returns 1 if the password assignment is successful and returns 0 if the assignment fails.
AssociateCAMIDToGroup
AssociateCAMIDToGroup creates an association between a TM1 user group and a CAMID.
CellSecurityCubeCreate
CellSecurityCubeCreate creates a security cube from an existing cube using a reduced set of dimensions. This function, like all functions that update metadata, should not be used in the Data or Epilog tabs of a process.
CellSecurityCubeDestroy
CellSecurityCubeDestroy destroys a security cube that was created from an existing cube. This function, like all functions that update metadata, should not be used in the Data or Epilog tabs of a process.
DeleteClient
DeleteClient deletes a client from the server. Changes applied through the DeleteClient function do not take effect until the Metadata procedure in a process is completed. This function, like all functions that update metadata, should not be used in the Data or Epilog tabs of a process
DeleteGroup
DeleteGroup deletes a user group from the server. Changes applied through the DeleteGroup function do not take effect until the Metadata procedure in a process is completed. This function, like all functions that update metadata, should not be used in the Data or Epilog tabs of a process.
ElementSecurityGet
ElementSecurityGet retrieves the security level assigned to a specified group for a dimension element.
ElementSecurityPut
ElementSecurityPut assigns a security level to a specified group for a dimension element.
HierarchyElementSecurityGet
HierarchyElementSecurityGet retrieves the security level assigned to a specified group for a dimension element.
HierarchyElementSecurityPut
HierarchyElementSecurityPut assigns a security level to a specified group for a dimension element.
RemoveCAMIDAssociation
RemoveCAMIDAssociation removes all associations between TM1 user groups and a specified CAMID.
RemoveCAMIDAssociationFromGroup
RemoveCAMIDAssociationFromGroup removes an association between a TM1 user group and a CAMID.
RemoveClientFromGroup
RemoveClientFromGroup removes a specified client from a user group.
SetHierarchyGroupsSecurity
SetHierarchyGroupsSecurity sets the security level for all existing groups for the specified dimension hierarchy.
SetHierarchyElementGroupsSecurity
SetHierarchyElementGroupsSecurity sets the security level for a specified element from a hierarchy in a dimension.
SetDimensionGroupsSecurity
SetDimensionGroupsSecurity sets the security level for all existing groups for the specified dimension.
SetElementGroupsSecurity
SetElementGroupsSecurity sets the security level for a specified element in a dimension.
SecurityOverlayGlobalLockCell
SecurityOverlayGlobalLockCell is used to restrict the access rights of a node to read-only by locking it. It uses the global overlay so all users are affected. The overlay cube must be created prior to using this command. The elements provided in the address must be only for the dimensions used in the overlay.
SecurityOverlayCreateGlobalDefault
SecurityOverlayCreateGlobalDefault is used to create or destroy a Security Overlay cube, and to set the overlay for a given area of a data cube.
SecurityOverlayDestroyGlobalDefault
SecurityOverlayDestroyGlobalDefault is used to destroy a Security Overlay cube, and to set the overlay for a given area of a data cube.
SecurityOverlayGlobalLockNode
SecurityOverlayGlobalLockNode is used to restrict the access rights of a node to read-only by locking it. It uses the global overlay so all users are affected. The overlay cube must be created prior to using this command. The elements provided in the address must be only for the dimensions used in the overlay.
SecurityRefresh
SecurityRefresh reads all the security control cubes and regenerates the internal structures in the server that are used by TM1® API functions.

Parent topic: TurboIntegrator Functions