IDRARestServer MembersDRA REST Extensions SDK
The IDRARestServer type exposes the following members.
Methods

  NameDescription
Public methodBuiltinContainerSetInfo
Updates the properties of a builtin container
UriTemplate: /dra/domains/{domainFqdn}/builtincontainers/put
Public methodComputerCreate
Creates a new computer object
UriTemplate: /dra/domains/{domainFqdn}/computers/post
Public methodComputerDelete
Deletes the specified computer
UriTemplate: /dra/domains/{domainFqdn}/computers/delete
Public methodComputerMove
Moves a computer to a new location
UriTemplate: /dra/domains/{domainFqdn}/computers/move
Public methodComputerReset
Resets a computer account
UriTemplate: /dra/domains/{domainFqdn}/computers/reset
Public methodComputerRestore
Restores a deleted computer from the recycle bin
UriTemplate: /dra/domains/{domainFqdn}/computers/restore
Public methodComputerSetInfo
Updates the properties of a computer
UriTemplate: /dra/domains/{domainFqdn}/computers/put
Public methodContactCopy
Copy the specified contact to a new contact
UriTemplate: /dra/domains/{domainFqdn}/contacts/copies
Public methodContactCreate
Creates a new contact object
UriTemplate: /dra/domains/{domainFqdn}/contacts/post
Public methodContactDelete
Deletes the specified contact
UriTemplate: /dra/domains/{domainFqdn}/contacts/delete
Public methodContactDisableEmail
Disables email on the specified contact.
UriTemplate: /dra/domains/{domainFqdn}/contacts/disableemail/put
Public methodContactEnableEmail
Enables email on the specified contact.
UriTemplate: /dra/domains/{domainFqdn}/contacts/enableemail/put
Public methodContactRestore
Restore the specified contact from the recycle bin
UriTemplate: /dra/domains/{domainFqdn}/contacts/restore
Public methodContactSetInfo
Updates the properties of a contact
UriTemplate: /dra/domains/{domainFqdn}/contacts/put
Public methodContainerEnum
Retrieves a list of managed objects that match the specified filters across all managed domains
UriTemplate: /dra/managedObjects/get
Public methodContainerSetInfo
Updates the properties of a container
UriTemplate: /dra/domains/{domainFqdn}/container/put
Public methodDynamicDistributionGroupCopy
Copy the specified ddg to a new ddg
UriTemplate: /dra/domains/{domainFqdn}/dynamicdistributiongroups/copies/post
Public methodDynamicDistributionGroupCreate
Creates a new dynamic distribution group object
UriTemplate: /dra/domains/{domainFqdn}/dynamicdistributiongroups/post
Public methodDynamicDistributionGroupDelete
Deletes the specified dynamic distribution group
UriTemplate: /dra/domains/{domainFqdn}/dynamicdistributiongroups/delete
Public methodDynamicDistributionGroupMove
Moves a dynamic distribution group to a new location
UriTemplate: /dra/domains/{domainFqdn}/dynamicdistributiongroups/move
Public methodDynamicDistributionGroupPreview
Preview the objects defined for a specified ddg
UriTemplate: /dra/domains/{domainFqdn}/dynamicdistributiongroups/preview
Public methodDynamicDistributionGroupRestore
Restore the specified dynamic distribution group from the recycle bin
UriTemplate: /dra/domains/{domainFqdn}/dynamicdistributiongroups/restore
Public methodDynamicDistributionGroupSetInfo
Updates the properties of a dynamic distribution group
UriTemplate: /dra/domains/{domainFqdn}/dynamicdistributiongroups/put
Public methodEquipmentMailboxCreate
Creates a new equipment mailbox object
UriTemplate: /dra/domains/{domainFqdn}/equipmentmailboxes/post
Public methodEquipmentMailboxGetRequest
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
Public methodGetBuiltinContainersRequest
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
Public methodGetComputersRequest
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
Public methodGetContactsRequest
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
Public methodGetContainersRequest
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
Public methodGetDomainControllersRequest
Retrieves the list of domain controlles in the specified domain.
UriTemplate: /dra/domains/{domainFqdn}/domaincontrollers/get
Public methodGetDomainsRequest
Retrieves a list of domains matching the specified search criteria or returns the requested attributes of a specified domain.
UriTemplate: /dra/domains/get
Public methodGetDraServersInDomain
Retrieves the list of DRA servers registered in the specified domain
UriTemplate: /dra/domains/{domainFqdn}/draservers/get
Public methodGetDynamicDistributionGroupsRequest
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
Public methodGetExchangeAdminGroups
Retrieves the list of Exchange admin groups in the specified domain.
UriTemplate: /dra/domains/{domainFqdn}/exchangeServers/adminGroups/get
Public methodGetExchangeAliasName
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
Public methodGetExchangeConfiguration
Retrieves Exchange configuration for the specified domain.
UriTemplate: /dra/domains/{domainFqdn}/exchangeConfiguration/get
Public methodGetExchangeMailboxStores
Retrieves the list of Exchange mailbox stores.
UriTemplate: /dra/domains/{domainFqdn}/exchangeServers/mailboxStores/get
Public methodGetExchangeResourceSchemaByType
Retrieves the list of Exchange custom resource room.
UriTemplate: /dra/domains/{domainFqdn}/exchangeServers/ResourceSchema/get
Public methodGetExchangeResourceSchemaEquipment
Retrieves the list of Exchange custom resource equipment
UriTemplate: /dra/domains/{domainFqdn}/exchangeServers/ResourceSchema/equipment/get
Public methodGetExchangeResourceSchemaRooms
Retrieves the list of Exchange custom resource rooms
UriTemplate: /dra/domains/{domainFqdn}/exchangeServers/ResourceSchema/rooms/get
Public methodGetExchangeServers
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
Public methodGetGroupsRequest
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
Public methodGetInformation
Defines REST endpoint for getting information about the running DRA REST service. This endpoint is accessed using HTTP GET.
UriTemplate: /rest
Public methodGetMailboxProperties
Retrieves rights/security information of specified mailbox
UriTemplate: /dra/domains/{domainFqdn}/users/mailbox/get
Public methodGetOUsRequest
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
Public methodGetPowersByCategory
Returns the property level permissions delegated to the caller over the specified object class for the specified operations
Public methodGetPowersByOperationName
Returns the operation level permissions delegated to the caller for the specified operations
Public methodGetPowersDelegatedToUser
Returns the DRA powers delegated to the specified user UriTemplate = "/dra/domains/{domainFqdn}/users/powers/get"
Public methodGetRecycleBins
Retrieves a list of recycle bins.
UriTemplate: /dra/recyclebins/get
Public methodGetResourceMailboxesRequest
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
Public methodGetUsersRequest
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
Public methodGroupCheckNames
Returns check names status UriTemplate = "/dra/domains/{domainFqdn}/groups/checkNames/get"
Public methodGroupCopy
Copy the specified group to a new group
UriTemplate: /dra/domains/{domainFqdn}/groups/copies/post
Public methodGroupCreate
Creates a new group
UriTemplate: /dra/domains/{domainFqdn}/groups/post
Public methodGroupDelete
Deletes the specified group
UriTemplate: /dra/domains/{domainFqdn}/groups/delete
Public methodGroupDisableEmail
Disables email on the specified group
UriTemplate: /dra/domains/{domainFqdn}/groups/disableemail/put
Public methodGroupEnableEmail
Enables email on the specified group
UriTemplate: /dra/domains/{domainFqdn}/groups/enableemail/put
Public methodGroupGetPermissions
Get a group permissions UriTemplate = "/dra/domains/{domainFqdn}/groups/permissions/get"
Public methodGroupMemberAdd
Adds the specified objects to the group
UriTemplate: /dra/domains/{domainFqdn}/groups/members/post
Public methodGroupMemberEnum
Enumerates the members of the group
UriTemplate: /dra/domains/{domainFqdn}/groups/members/get
Public methodGroupMemberRemove
Removes the specified objects from the group
UriTemplate: /dra/domains/{domainFqdn}/groups/members/delete
Public methodGroupMembershipEnum
Get group membership on the specified object
UriTemplate: /dra/domains/{domainFqdn}/groups/membership/get
Public methodGroupMove
Moves a group to a new location
UriTemplate: /dra/domains/{domainFqdn}/groups/move
Public methodGroupRestore
Restore the specified group from the recycle bin
UriTemplate: /dra/domains/{domainFqdn}/groups/restore
Public methodGroupSetInfo
Updates the properties of a group
UriTemplate: /dra/domains/{domainFqdn}/groups/put
Public methodGroupSetPermissions
Set a group permissions UriTemplate = "/dra/domains/{domainFqdn}/groups/permissions/put"
Public methodLDAPEnum
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
Public methodManagerGetInfo
Gets basic display information for an object that is set as a Manager or Assistant
UriTemplate: /dra/domains/{domainFqdn}/manager/get
Public methodObjectGetDisplayProperties
Gets display information for the requested objects
UriTemplate: /dra/managedObjects/displayProperties/get
Public methodOUCreate
Creates a new OU object
UriTemplate: /dra/domains/{domainFqdn}/ous/post
Public methodOUDelete
Deletes the specified OU
UriTemplate: /dra/domains/{domainFqdn}/ous/delete
Public methodOUMoveHere
Moves an OU from one container to another
UriTemplate: /dra/domains/{domainFqdn}/ous/move
Public methodOUSetInfo
Updates the properties of a OU
UriTemplate: /dra/domains/{domainFqdn}/ous/put
Public methodPasswordGenerate
Generates a random password based on the current password policy settings
UriTemplate: /dra/password/get
Public methodRecycleBinDomainEnum
Retrieves a list of managed objects from the specified domain's recycle bin that match the specified filters.
UriTemplate: /dra/recyclebins/{domainFqdn}/managedObjects/get
Public methodRecycleBinEnum
Retrieves a list of managed objects that match the specified filters across all recycle bins
UriTemplate: /dra/recyclebins/managedObjects/get
Public methodResourceMailboxCopy
Creates a copy of an existing resource mailbox
UriTemplate: /dra/domains/{domainFqdn}/resourcemailboxes/copies/post
Public methodResourceMailboxDelete
Deletes a resource mailbox
UriTemplate: /dra/domains/{domainFqdn}/resourcemailboxes/delete
Public methodResourceMailboxMove
Moves a resource mailbox to a new container
UriTemplate: /dra/domains/{domainFqdn}/resourcemailboxes/move
Public methodResourceMailboxRestore
Restore the specified resource mailbox from the recycle bin
UriTemplate: /dra/domains/{domainFqdn}/resourcemailboxes/restore
Public methodResourceMailboxSetInfo
Updates the properties of a resource mailbox
UriTemplate: /dra/domains/{domainFqdn}/resourcemailboxes/put
Public methodRoomMailboxCreate
Creates a new room mailbox object
UriTemplate: /dra/domains/{domainFqdn}/roommailboxes/post
Public methodRoomMailboxGetRequest
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
Public methodServerGetInfo
Retrieves information about the DRA server
UriTemplate: /dra/servers/current/get
Public methodSetMailboxProperties
Sets the rights/security information of specified mailbox
UriTemplate: /dra/domains/{domainFqdn}/users/mailbox/post
Public methodSubmitVarSet
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
Public methodUserCopy
Copy the specified user to a new user
UriTemplate: /dra/domains/{domainFqdn}/users/copies
Public methodUserCreate
Creates a new user object
UriTemplate: /dra/domains/{domainFqdn}/users/post
Public methodUserDelete
Deletes the specified user
UriTemplate: /dra/domains/{domainFqdn}/users/delete
Public methodUserDisable
Disables a user
UriTemplate: /dra/domains/{domainFqdn}/users/disable/put
Public methodUserDisableEmail
Disables email for the specified user.
UriTemplate: /dra/domains/{domainFqdn}/users/disableemail/put
Public methodUserDisableOffice365ArchiveMailbox
Disables office 365 archive mailbox on the specified user.
UriTemplate: /dra/domains/{domainFqdn}/users/office365/mailbox/disablearchive
Public methodUserEnable
Enables a user
UriTemplate: /dra/domains/{domainFqdn}/users/enable/put
Public methodUserEnableEmail
Enables email for the specified user.
UriTemplate: /dra/domains/{domainFqdn}/users/enableemail/put
Public methodUserEnableOffice365ArchiveMailbox
Enables office 365 archive mailbox on the specified user.
UriTemplate: /dra/domains/{domainFqdn}/users/office365/mailbox/enablearchive
Public methodUserMailboxCreate
Creates a mailbox for the specified user on the specified mailbox store.
UriTemplate: /dra/domains/{domainFqdn}/users/createmailbox/put
Public methodUserMailboxDelete
Deletes a mailbox for the specified user
UriTemplate: /dra/domains/{domainFqdn}/users/deletemailbox/put
Public methodUserMove
Moves a user from one container to another
UriTemplate: /dra/domains/{domainFqdn}/users/move
Public methodUserResetPassword
Resets the password and unlocks a user. User will be required to change password at next logon.
UriTemplate: /dra/domains/{domainFqdn}/users/resetpassword/put
Public methodUserRestore
Restore the specified user from the recycle bin
UriTemplate: /dra/domains/{domainFqdn}/users/restore
Public methodUserSetInfo
Updates the properties of a user
UriTemplate: /dra/domains/{domainFqdn}/users/put
Public methodUserUnlock
Unlocks a user, but does not reset the password
UriTemplate: /dra/domains/{domainFqdn}/users/unlock/put
Public methodVAAssociate
Creates a new virtual attribute association to a managed object class
UriTemplate: /dra/virtualAttributes/associations/post
Public methodVAAssociationsGet
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
Public methodVACreate
Creates a new virtual attribute
UriTemplate: /dra/virtualAttributes/post
Public methodVADisable
Disables a new virtual attribute
UriTemplate: /dra/virtualAttributes/disable/put
Public methodVADisassociate
Deletes a virtual attribute association to a managed object class
UriTemplate: /dra/virtualAttributes/associations/delete
Public methodVAEnable
Enables a new virtual attribute
UriTemplate: /dra/virtualAttributes/enable/put
Public methodVAPropertyEnum
Lists the virtual attributes defined for this DRA environment
UriTemplate: /dra/virtualAttributes/get
Public methodWorkflowEventCreate
Creates an Aegis workflow event
Back to Top
See Also