The IDRARestServer type exposes the following members.
Back to Top
Methods
Name | Description | |
---|---|---|
BuiltinContainerSetInfo |
Updates the properties of a builtin container
UriTemplate: /dra/domains/{domainFqdn}/builtincontainers/put | |
ComputerCreate |
Creates a new computer object
UriTemplate: /dra/domains/{domainFqdn}/computers/post | |
ComputerDelete |
Deletes the specified computer
UriTemplate: /dra/domains/{domainFqdn}/computers/delete | |
ComputerMove |
Moves a computer to a new location
UriTemplate: /dra/domains/{domainFqdn}/computers/move | |
ComputerReset |
Resets a computer account
UriTemplate: /dra/domains/{domainFqdn}/computers/reset | |
ComputerRestore |
Restores a deleted computer from the recycle bin
UriTemplate: /dra/domains/{domainFqdn}/computers/restore | |
ComputerSetInfo |
Updates the properties of a computer
UriTemplate: /dra/domains/{domainFqdn}/computers/put | |
ContactCopy |
Copy the specified contact to a new contact
UriTemplate: /dra/domains/{domainFqdn}/contacts/copies | |
ContactCreate |
Creates a new contact object
UriTemplate: /dra/domains/{domainFqdn}/contacts/post | |
ContactDelete |
Deletes the specified contact
UriTemplate: /dra/domains/{domainFqdn}/contacts/delete | |
ContactDisableEmail |
Disables email on the specified contact.
UriTemplate: /dra/domains/{domainFqdn}/contacts/disableemail/put | |
ContactEnableEmail |
Enables email on the specified contact.
UriTemplate: /dra/domains/{domainFqdn}/contacts/enableemail/put | |
ContactRestore |
Restore the specified contact from the recycle bin
UriTemplate: /dra/domains/{domainFqdn}/contacts/restore | |
ContactSetInfo |
Updates the properties of a contact
UriTemplate: /dra/domains/{domainFqdn}/contacts/put | |
ContainerEnum |
Retrieves a list of managed objects that match the specified filters across all managed domains
UriTemplate: /dra/managedObjects/get | |
ContainerSetInfo |
Updates the properties of a container
UriTemplate: /dra/domains/{domainFqdn}/container/put | |
DynamicDistributionGroupCopy |
Copy the specified ddg to a new ddg
UriTemplate: /dra/domains/{domainFqdn}/dynamicdistributiongroups/copies/post | |
DynamicDistributionGroupCreate |
Creates a new dynamic distribution group object
UriTemplate: /dra/domains/{domainFqdn}/dynamicdistributiongroups/post | |
DynamicDistributionGroupDelete |
Deletes the specified dynamic distribution group
UriTemplate: /dra/domains/{domainFqdn}/dynamicdistributiongroups/delete | |
DynamicDistributionGroupMove |
Moves a dynamic distribution group to a new location
UriTemplate: /dra/domains/{domainFqdn}/dynamicdistributiongroups/move | |
DynamicDistributionGroupPreview |
Preview the objects defined for a specified ddg
UriTemplate: /dra/domains/{domainFqdn}/dynamicdistributiongroups/preview | |
DynamicDistributionGroupRestore |
Restore the specified dynamic distribution group from the recycle bin
UriTemplate: /dra/domains/{domainFqdn}/dynamicdistributiongroups/restore | |
DynamicDistributionGroupSetInfo |
Updates the properties of a dynamic distribution group
UriTemplate: /dra/domains/{domainFqdn}/dynamicdistributiongroups/put | |
EquipmentMailboxCreate |
Creates a new equipment mailbox object
UriTemplate: /dra/domains/{domainFqdn}/equipmentmailboxes/post | |
EquipmentMailboxGetRequest |
Retrieves a list of equipment mailboxes matching the specified search criteria or returns the requested attributes of a specified equipment mailbox.
UriTemplate: /dra/domains/{domainFqdn}/equipmentmailboxes/get | |
GetBuiltinContainersRequest |
Retrieves a list of builtin containers matching the specified search criteria or returns the requested attributes of a specified builtin container.
UriTemplate: /dra/domains/{domainFqdn}/builtincontainers/get | |
GetComputersRequest |
Retrieves a list of computers matching the specified search criteria or returns the requested attributes of a specified computer.
UriTemplate: /dra/domains/{domainFqdn}/computers/get | |
GetContactsRequest |
Retrieves a list of contacts matching the specified search criteria or returns the requested attributes of a specified contact.
UriTemplate: /dra/domains/{domainFqdn}/contacts/get | |
GetContainersRequest |
Retrieves a list of containers matching the specified search criteria or returns the requested attributes of a specified container.
UriTemplate: /dra/domains/{domainFqdn}/containers/get | |
GetDomainControllersRequest |
Retrieves the list of domain controlles in the specified domain.
UriTemplate: /dra/domains/{domainFqdn}/domaincontrollers/get | |
GetDomainsRequest |
Retrieves a list of domains matching the specified search criteria or returns the requested attributes of a specified domain.
UriTemplate: /dra/domains/get | |
GetDraServersInDomain |
Retrieves the list of DRA servers registered in the specified domain
UriTemplate: /dra/domains/{domainFqdn}/draservers/get | |
GetDynamicDistributionGroupsRequest |
Retrieves a list of dynamic distribution groups matching the specified search criteria or returns the requested properties of a specified dynamic distribution group.
UriTemplate: /dra/domains/{domainFqdn}/dynamicdistributiongroups/get | |
GetExchangeAdminGroups |
Retrieves the list of Exchange admin groups in the specified domain.
UriTemplate: /dra/domains/{domainFqdn}/exchangeServers/adminGroups/get | |
GetExchangeAliasName |
Retrieves exchange name alias. The Exchange alias is used with address lists as an alternative way of specifying the user in the To, Cc, or Bcc text boxes
of an e-mail message. (This is sometimes referred to as the nickname property.)
This method accepts the first and last name, the initials and the samAccountName. Based on the values in these fields, the server
will generate the alias according to policy set on the server. The default (no policy set) is the same as the samAccountName.
The required parameters depend on what policy is set. For example, if the selected policy is 'First-Initials-Last', then the
you should send firstName, initials, and lastName. When no policy is set, samAccountName is required.
UriTemplate: /dra/domains/{domainFqdn}/exchangeName/alias/get | |
GetExchangeConfiguration |
Retrieves Exchange configuration for the specified domain.
UriTemplate: /dra/domains/{domainFqdn}/exchangeConfiguration/get | |
GetExchangeMailboxStores |
Retrieves the list of Exchange mailbox stores.
UriTemplate: /dra/domains/{domainFqdn}/exchangeServers/mailboxStores/get | |
GetExchangeResourceSchemaByType |
Retrieves the list of Exchange custom resource room.
UriTemplate: /dra/domains/{domainFqdn}/exchangeServers/ResourceSchema/get | |
GetExchangeResourceSchemaEquipment |
Retrieves the list of Exchange custom resource equipment
UriTemplate: /dra/domains/{domainFqdn}/exchangeServers/ResourceSchema/equipment/get | |
GetExchangeResourceSchemaRooms |
Retrieves the list of Exchange custom resource rooms
UriTemplate: /dra/domains/{domainFqdn}/exchangeServers/ResourceSchema/rooms/get | |
GetExchangeServers |
Retrieves the list of Exchange servers in the specified domain. Returns properties about each server such as the LDAP path.
UriTemplate: /dra/domains/{domainFqdn}/exchangeServers/get | |
GetGroupsRequest |
Retrieves a list of groups matching the specified search criteria or returns the requested properties of a specified group.
UriTemplate: /dra/domains/{domainFqdn}/groups/get | |
GetInformation |
Defines REST endpoint for getting information about the running DRA REST service.
This endpoint is accessed using HTTP GET.
UriTemplate: /rest | |
GetMailboxProperties |
Retrieves rights/security information of specified mailbox
UriTemplate: /dra/domains/{domainFqdn}/users/mailbox/get | |
GetOUsRequest |
Retrieves a list of organizational units matching the specified search criteria or returns the requested attributes of a specified organizational unit.
UriTemplate: /dra/domains/{domainFqdn}/ous/get | |
GetPowersByCategory |
Returns the property level permissions delegated to the caller over the specified object class for the specified operations
| |
GetPowersByOperationName |
Returns the operation level permissions delegated to the caller for the specified operations
| |
GetPowersDelegatedToUser |
Returns the DRA powers delegated to the specified user
UriTemplate = "/dra/domains/{domainFqdn}/users/powers/get"
| |
GetRecycleBins |
Retrieves a list of recycle bins.
UriTemplate: /dra/recyclebins/get | |
GetResourceMailboxesRequest |
Retrieves a list of resource mailboxes matching the specified search criteria or returns the requested attributes of a specified resource mailbox.
UriTemplate: /dra/domains/{domainFqdn}/resourcemailboxes/get | |
GetUsersRequest |
Retrieves a list of users matching the specified search criteria or returns the requested attributes of a specified user.
UriTemplate: /dra/domains/{domainFqdn}/users/get | |
GroupCheckNames |
Returns check names status
UriTemplate = "/dra/domains/{domainFqdn}/groups/checkNames/get"
| |
GroupCopy |
Copy the specified group to a new group
UriTemplate: /dra/domains/{domainFqdn}/groups/copies/post | |
GroupCreate |
Creates a new group
UriTemplate: /dra/domains/{domainFqdn}/groups/post | |
GroupDelete |
Deletes the specified group
UriTemplate: /dra/domains/{domainFqdn}/groups/delete | |
GroupDisableEmail |
Disables email on the specified group
UriTemplate: /dra/domains/{domainFqdn}/groups/disableemail/put | |
GroupEnableEmail |
Enables email on the specified group
UriTemplate: /dra/domains/{domainFqdn}/groups/enableemail/put | |
GroupGetPermissions |
Get a group permissions
UriTemplate = "/dra/domains/{domainFqdn}/groups/permissions/get"
| |
GroupMemberAdd |
Adds the specified objects to the group
UriTemplate: /dra/domains/{domainFqdn}/groups/members/post | |
GroupMemberEnum |
Enumerates the members of the group
UriTemplate: /dra/domains/{domainFqdn}/groups/members/get | |
GroupMemberRemove |
Removes the specified objects from the group
UriTemplate: /dra/domains/{domainFqdn}/groups/members/delete | |
GroupMembershipEnum |
Get group membership on the specified object
UriTemplate: /dra/domains/{domainFqdn}/groups/membership/get | |
GroupMove |
Moves a group to a new location
UriTemplate: /dra/domains/{domainFqdn}/groups/move | |
GroupRestore |
Restore the specified group from the recycle bin
UriTemplate: /dra/domains/{domainFqdn}/groups/restore | |
GroupSetInfo |
Updates the properties of a group
UriTemplate: /dra/domains/{domainFqdn}/groups/put | |
GroupSetPermissions |
Set a group permissions
UriTemplate = "/dra/domains/{domainFqdn}/groups/permissions/put"
| |
LDAPEnum |
Retrieves a list of objects that match the specified LDAP query in the specified container. The LDAP query and the container are both specified
in the enumerationsOptions object
UriTemplate: /dra/ldapQuery/get | |
ManagerGetInfo |
Gets basic display information for an object that is set as a Manager or Assistant
UriTemplate: /dra/domains/{domainFqdn}/manager/get | |
ObjectGetDisplayProperties |
Gets display information for the requested objects
UriTemplate: /dra/managedObjects/displayProperties/get | |
OUCreate |
Creates a new OU object
UriTemplate: /dra/domains/{domainFqdn}/ous/post | |
OUDelete |
Deletes the specified OU
UriTemplate: /dra/domains/{domainFqdn}/ous/delete | |
OUMoveHere |
Moves an OU from one container to another
UriTemplate: /dra/domains/{domainFqdn}/ous/move | |
OUSetInfo |
Updates the properties of a OU
UriTemplate: /dra/domains/{domainFqdn}/ous/put | |
PasswordGenerate |
Generates a random password based on the current password policy settings
UriTemplate: /dra/password/get | |
RecycleBinDomainEnum |
Retrieves a list of managed objects from the specified domain's recycle bin that match the specified filters.
UriTemplate: /dra/recyclebins/{domainFqdn}/managedObjects/get | |
RecycleBinEnum |
Retrieves a list of managed objects that match the specified filters across all recycle bins
UriTemplate: /dra/recyclebins/managedObjects/get | |
ResourceMailboxCopy |
Creates a copy of an existing resource mailbox
UriTemplate: /dra/domains/{domainFqdn}/resourcemailboxes/copies/post | |
ResourceMailboxDelete |
Deletes a resource mailbox
UriTemplate: /dra/domains/{domainFqdn}/resourcemailboxes/delete | |
ResourceMailboxMove |
Moves a resource mailbox to a new container
UriTemplate: /dra/domains/{domainFqdn}/resourcemailboxes/move | |
ResourceMailboxRestore |
Restore the specified resource mailbox from the recycle bin
UriTemplate: /dra/domains/{domainFqdn}/resourcemailboxes/restore | |
ResourceMailboxSetInfo |
Updates the properties of a resource mailbox
UriTemplate: /dra/domains/{domainFqdn}/resourcemailboxes/put | |
RoomMailboxCreate |
Creates a new room mailbox object
UriTemplate: /dra/domains/{domainFqdn}/roommailboxes/post | |
RoomMailboxGetRequest |
Retrieves a list of room mailboxes matching the specified search criteria or returns the requested attributes of a specified room mailbox.
UriTemplate: /dra/domains/{domainFqdn}/roommailboxes/get | |
ServerGetInfo |
Retrieves information about the DRA server
UriTemplate: /dra/servers/current/get | |
SetMailboxProperties |
Sets the rights/security information of specified mailbox
UriTemplate: /dra/domains/{domainFqdn}/users/mailbox/post | |
SubmitVarSet |
Defines the REST endpoint for using a VARSET to perform any DRA operation. The varset keys and values
are loaded from the submitted payload.
Format for varset entries is "varsetKey":"varsetValue"
UriTemplate: /dra/operations/varset/post | |
UserCopy |
Copy the specified user to a new user
UriTemplate: /dra/domains/{domainFqdn}/users/copies | |
UserCreate |
Creates a new user object
UriTemplate: /dra/domains/{domainFqdn}/users/post | |
UserDelete |
Deletes the specified user
UriTemplate: /dra/domains/{domainFqdn}/users/delete | |
UserDisable |
Disables a user
UriTemplate: /dra/domains/{domainFqdn}/users/disable/put | |
UserDisableEmail |
Disables email for the specified user.
UriTemplate: /dra/domains/{domainFqdn}/users/disableemail/put | |
UserDisableOffice365ArchiveMailbox |
Disables office 365 archive mailbox on the specified user.
UriTemplate: /dra/domains/{domainFqdn}/users/office365/mailbox/disablearchive | |
UserEnable |
Enables a user
UriTemplate: /dra/domains/{domainFqdn}/users/enable/put | |
UserEnableEmail |
Enables email for the specified user.
UriTemplate: /dra/domains/{domainFqdn}/users/enableemail/put | |
UserEnableOffice365ArchiveMailbox |
Enables office 365 archive mailbox on the specified user.
UriTemplate: /dra/domains/{domainFqdn}/users/office365/mailbox/enablearchive | |
UserMailboxCreate |
Creates a mailbox for the specified user on the specified mailbox store.
UriTemplate: /dra/domains/{domainFqdn}/users/createmailbox/put | |
UserMailboxDelete |
Deletes a mailbox for the specified user
UriTemplate: /dra/domains/{domainFqdn}/users/deletemailbox/put | |
UserMove |
Moves a user from one container to another
UriTemplate: /dra/domains/{domainFqdn}/users/move | |
UserResetPassword |
Resets the password and unlocks a user. User will be required to change password at next logon.
UriTemplate: /dra/domains/{domainFqdn}/users/resetpassword/put | |
UserRestore |
Restore the specified user from the recycle bin
UriTemplate: /dra/domains/{domainFqdn}/users/restore | |
UserSetInfo |
Updates the properties of a user
UriTemplate: /dra/domains/{domainFqdn}/users/put | |
UserUnlock |
Unlocks a user, but does not reset the password
UriTemplate: /dra/domains/{domainFqdn}/users/unlock/put | |
VAAssociate |
Creates a new virtual attribute association to a managed object class
UriTemplate: /dra/virtualAttributes/associations/post | |
VAAssociationsGet |
Lists virtual attributes associated to the specified class name. If no
class name is provided, returns virtual attributes not associated with any class
UriTemplate: /dra/virtualAttributes/associations/get | |
VACreate |
Creates a new virtual attribute
UriTemplate: /dra/virtualAttributes/post | |
VADisable |
Disables a new virtual attribute
UriTemplate: /dra/virtualAttributes/disable/put | |
VADisassociate |
Deletes a virtual attribute association to a managed object class
UriTemplate: /dra/virtualAttributes/associations/delete | |
VAEnable |
Enables a new virtual attribute
UriTemplate: /dra/virtualAttributes/enable/put | |
VAPropertyEnum |
Lists the virtual attributes defined for this DRA environment
UriTemplate: /dra/virtualAttributes/get | |
WorkflowEventCreate |
Creates an Aegis workflow event
|
See Also