Autodesk Vault ProfessionalVault API

AdminService Class

Autodesk.Connectivity.WebServicesAutodesk.Connectivity.WebServices

Contains methods for manipulating users and groups.

Syntax

public sealed class AdminService : AdminServiceBase, IWebService  
Public NotInheritable Class AdminService
   Inherits AdminServiceBase
   Implements IWebService 

Methods

NameDescription
AddGroupCreates a new Group of Users.
AddGroupManager
AddGroupRoleAdds a role to a group.
AddGroupsToGroupAdds a set of Groups to a parent Group.
AddGroupToGroupAdds a Group to a parent Group.
AddGroupToVaultGives a Group access to a Vault.
AddProfileAttributeDefAdds a new profile attribute definition. Added to end of the display order.
AddRoleCreates a new user-defined role.
AddUserAdds a user.
AddUserRoleAssociates a user with a role.
AddUsersToGroupAdds a set of Users to a Group.
AddUserToGroupAdds a User to a Group.
ChangeVaultAccountPasswordChanges the user's password. Now requires the old password to be specified.
CheckRolePermissionsCheck if the current logged in user has permission to execute specific web service APIs
ClearCachesClears information cached by the server.
DeleteGroupFromGroupDeletes a child Group from a Group.
DeleteGroupFromVaultRemoves access to a Vault from a Group.
DeleteGroupRoleRemoves a Role from a Group.
DeleteGroupsFromGroupRemoves child Groups from a Group.
DeleteProfileAttributeDefDeletes an existing profile attribute definition.
DeleteRoleDeletes a user-defined role.
DeleteUserFromGroupDeletes a User from a Group.
DeleteUserRoleRemoves a role from a user.
DeleteUsersFromGroupDeletes a set of Users from a Group.
GetAllGroupsGets a list of all Groups on the server.
GetAllPermissionsReturns all permissions.
GetAllRolesGets a list of all user roles.
GetAllUsersGets a list of all users.
GetChildGroupIdsByGroupIdGets all the child groups for a given group
GetCreateDomainUserOnLoginTells if the server is set up to automatically create domain users when they attempt to log in for the first time.
GetEffectiveUserInfoByUserId
GetGroupByIdGets a group by its ID.
GetGroupByNameGets a group by its name.
GetGroupInfoByGroupIdGets a Group and related information.
GetGroupInfosByGroupIdsGets a set Groups and related information.
GetGroupsByIdsGets a set of groups based on their IDs.
GetGroupsByNamesGets a list of groups.
GetMemberGroupsByGroupIdGets the immediate child Groups for a given Group.
GetMemberUsersByGroupIdGets all the immediate child Users of the given Group.
GetParentGroupIdsByGroupIdGets the IDs of all the groups that a user or group belongs to.
GetPasswordPolicySetting
GetPermissionsByRoleIdGets the permissions for a role.
GetPermissionsByUserIdGets the permissions for a user.
GetProfileAttributeDefsGets all profile attributes for the given association (returned in display order).
GetProfileAttributesGets profile attributes for the combination of user/group ids and attribute ids.
GetRolesByUserIdGets the roles for a user.
GetRolesUsageCountsGets the counts indicating how many users and groups are assigned the roles
GetServerConfigurationGets various peices of configuration information.
GetUserByUserIdGets the user object associated with the specified userId.
GetUserInfoByUserIdGets the user information for the specified user ID.
GetUserInfosByUserIdsGets a set of user information for a set of user IDs.
LinkActiveDirAccountToGroupAssociates an active directory account with the group by groupId.
LinkActiveDirAccountToUserAssociates an active directory account with the user by userId.
LinkAutodeskAccountToUserAssociates an Autodesk account with the user by userID
LinkVaultAccountToUserAssociates a Vault account and password with the user by userId. Can be used to reset Vault account password for the user.
RemoveGroupManager
SetCreateDomainUserOnLoginTurns on or off the feature that allows domain users to be automatically created when a user first logs in.
SetPasswordPolicySetting
SetProfileAttributeOrderSets display order for profile attributes (GetProfileAttributeDefs will return results in the same order).
UpdateGroupInfoUpdates a group and its associations.
UpdateGroupManagers
UpdateGroupMemebers
UpdateProfileAttributeDefUpdates a profile attribute definition.
UpdateRoleUpdates a user-defined role.
UpdateUserInfoUpdates a User and its associations.

Returned By

Where you get a AdminService — members that return one.

Inheritance Hierarchy

See Also