Security functions

Note: To run the Security functions, you must log on as a user with Administer permissions. Data roles are not synchronized automatically when you call the security functions. To synchronize data roles to OLAP, you must manually call the OLAPUpdateRoles function.

SecurityAddGroupToBasicGroup

Declaration

void SecurityAddGroupToBasicGroup(RepositoryConnection repositoryConnection, AuthenticationSystem authenticationSystem, string registeredGroupName, string basicGroupName)

Description

Adds a group to a basic group.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`authenticationSystem`	`Authentication system.`
`registeredGroupName`	`Group name.`
`basicGroupName`	`Basic group name.`

Return Value

Does not return a value.

SecurityAddUserToBasicGroup

Declaration

void SecurityAddUserToBasicGroup(RepositoryConnection repositoryConnection, AuthenticationSystem authenticationSystem, string userName, string groupName)

Description

Adds a user to a basic group.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`authenticationSystem`	`Authentication system.`
`userName`	`User name.`
`groupName`	`Basic group name.`

Return Value

Does not return a value.

SecurityAssignPermissionToApplicationRole

Declaration

void SecurityAssignPermissionToApplicationRole(RepositoryConnection repositoryConnection, string applicationName, string roleName, ApplicationPermission permission)

Description

Assigns a permission to an application role.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`applicationName`	`Application name.`
`roleName`	`The name of an application role.`
`permission`	`The permission to assign.`

Return Value

Does not return a value.

SecurityAssignPermissionToDataRole

Declaration

void SecurityAssignPermissionToDataRole(RepositoryConnection repositoryConnection, string applicationName, string roleName, DataPermission permission)

Description

Assigns a permission to a data role.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`applicationName`	`Application name.`
`roleName`	`The name of an application role.`
`permission`	`The permission to assign.`

Return Value

Does not return a value.

SecurityAssignRoleToGroup

Declaration

void SecurityAssignRoleToGroup(RepositoryConnection repositoryConnection, AuthenticationSystem authenticationSystem, string groupName, string applicationName, RoleType roleType, string roleName)

Description

Assigns a role to a group.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`authenticationSystem`	`Authentication system.`
`groupName`	`Group name.`
`applicationName`	`Application name.`
`roleType`	`Role type.`
`roleName`	`The name of a role.`

Return Value

Does not return a value.

SecurityAssignRoleToUser

Declaration

void SecurityAssignRoleToUser(RepositoryConnection repositoryConnection, AuthenticationSystem authenticationSystem, string userName, string applicationName, RoleType roleType, string roleName)

Description

Assigns a role to a user.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`authenticationSystem`	`Authentication system.`
`userName`	`User name.`
`applicationName`	`Application name.`
`roleType`	`Role type.`
`roleName`	`The name of a role.`

Return Value

Does not return a value.

SecurityCreateBasicGroup

Declaration

void SecurityCreateBasicGroup(RepositoryConnection repositoryConnection, string groupName, string description)

Description

Creates a new basic group in a repository.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`groupName`	`The name of a new group.`
`description`	`The description of a new group.`

Return Value

Does not return a value.

SecurityCreateBasicUser

Declaration

void SecurityCreateBasicUser(RepositoryConnection repositoryConnection, string userName, string password, string description, bool forcePasswordChange)

Description

Creates a new basic user in a repository.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`userName`	`The name of a new user.`
`password`	`The password of a new user.`
`description`	`The description of a new user.`
`forcePasswordChange`	`If true, a user is forced to change the password on the first logon.`

Return Value

Does not return a value.

SecurityCreateBasicUser

Declaration

void SecurityCreateBasicUser(RepositoryConnection repositoryConnection, string userName, string password, string description)

Description

Creates a new basic user in a repository. The user is asked to change password on the first logon.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`userName`	`The name of a new user.`
`password`	`The password of a new user.`
`description`	`The description of a new user.`

Return Value

Does not return a value.

SecurityCreateRegisteredGroup

Declaration

void SecurityCreateRegisteredGroup(RepositoryConnection repositoryConnection, AuthenticationSystem authenticationSystem, string groupName, string groupIdentifier, string description)

Description

Searches for a group in the authentication system by a given name or identifier (if a name is empty). Creates a new registered group in a repository if a group is found. Search rules depend on the authentication system.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`authenticationSystem`	`Authentication system.`
`groupName`	`Group name in the authentication system.`
`groupIdentifier`	`Group identifier in the authentication system. Used only if groupName is empty.`
`description`	`The description of a new group.`

Return Value

Does not return a value.

SecurityCreateRegisteredUser

Declaration

void SecurityCreateRegisteredUser(RepositoryConnection repositoryConnection, AuthenticationSystem authenticationSystem, string userName, string userIdentifier, string description)

Description

Searches for a user in the authentication system by a given name or identifier (if a name is empty). Creates a new registered user in a repository if a user is found. Search rules depend on the authentication system.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`authenticationSystem`	`Authentication system.`
`userName`	`User name in the authentication system.`
`userIdentifier`	`User identifier in the authentication system. Used only if userName is empty.`
`description`	`The description of a new user.`

Return Value

Does not return a value.

SecurityCreateRole

Declaration

void SecurityCreateRole(RepositoryConnection repositoryConnection, string applicationName, RoleType roleType, string roleName, string description)

Description

Creates a new role.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`applicationName`	`The name of an application.`
`roleType`	`Role type.`
`roleName`	`The name of a new role.`
`description`	`The description of a new role.`

Return Value

Does not return a value.

SecurityDeleteGroup

Declaration

void SecurityDeleteGroup(RepositoryConnection repositoryConnection, AuthenticationSystem authenticationSystem, string groupName)

Description

Deletes an existing repository group.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`authenticationSystem`	`Authentication system.`
`groupName`	`The name of a group to be deleted.`

Return Value

Does not return a value.

SecurityDeleteRole

Declaration

void SecurityDeleteRole(RepositoryConnection repositoryConnection, string applicationName, RoleType roleType, string roleName)

Description

Deletes a role.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`applicationName`	`The name of an application.`
`roleType`	`Role type.`
`roleName`	`The name of a role to delete.`

Return Value

Does not return a value.

SecurityDeleteUser

Declaration

void SecurityDeleteUser(RepositoryConnection repositoryConnection, AuthenticationSystem authenticationSystem, string userName)

Description

Deletes an existing user from a repository.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`authenticationSystem`	`Authentication system.`
`userName`	`The name of a user to be deleted.`

Return Value

Does not return a value.

SecurityGetBasicGroupsOfGroup

Declaration

StringList SecurityGetBasicGroupsOfGroup(RepositoryConnection repositoryConnection, AuthenticationSystem authenticationSystem, string registeredGroupName)

Description

Returns a list of basic group names for a given registered group.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`authenticationSystem`	`Authentication system.`
`registeredGroupName`	`Registered group name.`

Return Value

List of basic group names.

SecurityGetBasicGroupsOfUser

Declaration

StringList SecurityGetBasicGroupsOfUser(RepositoryConnection repositoryConnection, AuthenticationSystem authenticationSystem, string userName)

Description

Returns a list of basic group names for a given user.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`authenticationSystem`	`Authentication system.`
`userName`	`User name.`

Return Value

List of basic group names.

SecurityGetGroupNames

Declaration

StringList SecurityGetGroupNames(RepositoryConnection repositoryConnection, AuthenticationSystem authenticationSystem)

Description

Gets a list of repository groups of the authentication system.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`authenticationSystem`	`Authentication system.`

Return Value

A string list of group names.

SecurityGetGroupNames

Declaration

StringListList SecurityGetGroupNames(RepositoryConnection repositoryConnection)

Description

Gets a list of repository groups from all authentication systems.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`

Return Value

A string list of lists of group names and their authentication systems.

SecurityGetGroupProperty

Declaration

string SecurityGetGroupProperty(RepositoryConnection repositoryConnection, AuthenticationSystem authenticationSystem, string groupName, GroupProperty property)

Description

Gets a property of a repository group.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`authenticationSystem`	`Authentication system.`
`groupName`	`The name of a group.`
`property`	`The type of a property of a group.`

Return Value

The property of a group.

SecurityGetGroupsOfBasicGroup

Declaration

StringList SecurityGetGroupsOfBasicGroup(RepositoryConnection repositoryConnection, AuthenticationSystem authenticationSystem, string basicGroupName)

Description

Returns a list of group names registered with a given authentication system which has been assigned to a given basic group.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`authenticationSystem`	`Authentication system.`
`basicGroupName`	`Basic group name.`

Return Value

A list of group names.

SecurityGetPermissionsOfApplicationRole

Declaration

StringList SecurityGetPermissionsOfApplicationRole(RepositoryConnection repositoryConnection, string applicationName, string roleName)

Description

Returns a list of permissions of an application role.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`applicationName`	`Basic user name.`
`roleName`	`The name of an application role.`

Return Value

A list of application roles.

SecurityGetPermissionsOfDataRole

Declaration

StringList SecurityGetPermissionsOfDataRole(RepositoryConnection repositoryConnection, string applicationName, string roleName)

Description

Returns a list of permissions of a data role.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`applicationName`	`Basic user name.`
`roleName`	`The name of an application role.`

Return Value

A list of application roles.

SecurityGetRoleNames

Declaration

StringList SecurityGetRoleNames(RepositoryConnection repositoryConnection, string applicationName, RoleType roleType)

Description

Returns a list of roles.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`applicationName`	`Basic user name.`
`roleType`	`Role type.`

Return Value

A list of roles.

SecurityGetRoleProperty

Declaration

string SecurityGetRoleProperty(RepositoryConnection repositoryConnection, string applicationName, RoleType roleType, string roleName, RoleProperty property)

Description

Gets a property of a role.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`applicationName`	`The name of an application.`
`roleType`	`Role type.`
`roleName`	`The name of a role.`
`property`	`The type of a property of a role.`

Return Value

The property of a role.

SecurityGetRolesOfGroup

Declaration

StringList SecurityGetRolesOfGroup(RepositoryConnection repositoryConnection, AuthenticationSystem authenticationSystem, string groupName, string applicationName, RoleType roleType)

Description

Returns a list of roles assigned to a registered group.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`authenticationSystem`	`Authentication system.`
`groupName`	`Registered group name.`
`applicationName`	`Application name.`
`roleType`	`Role type.`

Return Value

A list of roles.

SecurityGetRolesOfUser

Declaration

StringList SecurityGetRolesOfUser(RepositoryConnection repositoryConnection, AuthenticationSystem authenticationSystem, string userName, string applicationName, RoleType roleType)

Description

Returns a list of roles assigned to a user.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`authenticationSystem`	`Authentication system.`
`userName`	`User name.`
`applicationName`	`Application name.`
`roleType`	`Role type.`

Return Value

A list of roles.

SecurityGetUserNames

Declaration

StringList SecurityGetUserNames(RepositoryConnection repositoryConnection, AuthenticationSystem authenticationSystem)

Description

Gets a list of repository users of the authentication system.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`authenticationSystem`	`Authentication system.`

Return Value

A string list of user names.

SecurityGetUserNames

Declaration

StringListList SecurityGetUserNames(RepositoryConnection repositoryConnection)

Description

Gets a list of repository users from all authentication systems.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`

Return Value

A string list of lists of user names and their authentication systems.

SecurityGetUserProperty

Declaration

string SecurityGetUserProperty(RepositoryConnection repositoryConnection, AuthenticationSystem authenticationSystem, string userName, UserProperty property)

Description

Gets a property of a repository user.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`authenticationSystem`	`Authentication system.`
`userName`	`The name of a user.`
`property`	`The type of a property of a user.`

Return Value

The property of a user.

SecurityGetUsersOfBasicGroup

Declaration

StringList SecurityGetUsersOfBasicGroup(RepositoryConnection repositoryConnection, AuthenticationSystem authenticationSystem, string groupName)

Description

Returns a list of group names registered with a given authentication system which has been assigned to a given basic group.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`authenticationSystem`	`Authentication system.`
`groupName`	`Basic group name.`

Return Value

A list of user names.

SecurityRemoveGroupFromBasicGroup

Declaration

void SecurityRemoveGroupFromBasicGroup(RepositoryConnection repositoryConnection, AuthenticationSystem authenticationSystem, string registeredGroupName, string basicGroupName)

Description

Removes a group from a basic group.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`authenticationSystem`	`Authentication system.`
`registeredGroupName`	`Group name.`
`basicGroupName`	`Basic group name.`

Return Value

Does not return a value.

SecurityRemoveUserFromBasicGroup

Declaration

void SecurityRemoveUserFromBasicGroup(RepositoryConnection repositoryConnection, AuthenticationSystem authenticationSystem, string userName, string groupName)

Description

Removes a user from a basic group.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`authenticationSystem`	`Authentication system.`
`userName`	`User name.`
`groupName`	`Basic group name.`

Return Value

Does not return a value.

SecurityRetractPermissionFromApplicationRole

Declaration

void SecurityRetractPermissionFromApplicationRole(RepositoryConnection repositoryConnection, string applicationName, string roleName, ApplicationPermission permission)

Description

Retracts a permission from an application role.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`applicationName`	`Application name.`
`roleName`	`The name of an application role.`
`permission`	`The permission to retract.`

Return Value

Does not return a value.

SecurityRetractPermissionFromDataRole

Declaration

void SecurityRetractPermissionFromDataRole(RepositoryConnection repositoryConnection, string applicationName, string roleName, DataPermission permission)

Description

Retracts a permission from a data role.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`applicationName`	`Application name.`
`roleName`	`The name of an application role.`
`permission`	`The permission to retract.`

Return Value

Does not return a value.

SecurityRetractRoleFromGroup

Declaration

void SecurityRetractRoleFromGroup(RepositoryConnection repositoryConnection, AuthenticationSystem authenticationSystem, string groupName, string applicationName, RoleType roleType, string roleName)

Description

Retracts a role from a group.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`authenticationSystem`	`Authentication system.`
`groupName`	`Group name.`
`applicationName`	`Application name.`
`roleType`	`Role type.`
`roleName`	`The name of a role.`

Return Value

Does not return a value.

SecurityRetractRoleFromUser

Declaration

void SecurityRetractRoleFromUser(RepositoryConnection repositoryConnection, AuthenticationSystem authenticationSystem, string userName, string applicationName, RoleType roleType, string roleName)

Description

Retracts a role from a user.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`authenticationSystem`	`Authentication system.`
`userName`	`User name.`
`applicationName`	`Application name.`
`roleType`	`Role type.`
`roleName`	`The name of a role.`

Return Value

Does not return a value.

SecuritySetGroupProperty

Declaration

void SecuritySetGroupProperty(RepositoryConnection repositoryConnection, AuthenticationSystem authenticationSystem, string groupName, GroupProperty property, string value)

Description

Sets a property of a repository group.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`authenticationSystem`	`Authentication system.`
`groupName`	`The name of a group.`
`property`	`The type of a property of a group.`
`value`	`The value of a property to set.`

Return Value

Does not return a value.

SecuritySetRoleProperty

Declaration

void SecuritySetRoleProperty(RepositoryConnection repositoryConnection, string applicationName, RoleType roleType, string roleName, RoleProperty property, string value)

Description

Sets a property of a role.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`applicationName`	`The name of an application.`
`roleType`	`Role type.`
`roleName`	`The name of a role.`
`property`	`The type of a property of a group.`
`value`	`The value of a property to set.`

Return Value

Does not return a value.

SecuritySetUserProperty

Declaration

void SecuritySetUserProperty(RepositoryConnection repositoryConnection, AuthenticationSystem authenticationSystem, string userName, UserProperty property, string value)

Description

Sets a property of a repository user.

Supported Runtime Versions

5.0


`Parameters`	`Description`
`repositoryConnection`	`Repository connection.`
`authenticationSystem`	`Authentication system.`
`userName`	`The name of a user.`
`property`	`The type of a property of a user.`
`value`	`The value of a property to set.`

Return Value

Does not return a value.