Therefore Web API Programming Interface 1.0

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Save Permalink URL

Therefore Web API > Web API Reference > Operations

GetPermissions

REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/GetPermissions

SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetPermissions

DEPRECATED: Use the GetRolePermissions method instead. Gets the permission list directly set for the user on the specified object.

Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetPermissions

Element Name	Element Type	Restrictions	Description
■ parameters
■ ObjectNo	xs:int	mandatory	Sets the identifier for the object (e.g. for documents this is the document number, for a category this is the category number).
■ ObjectType		mandatory restriction enum (xs:string) - Unknown (-1) - Server (1) - Document (2) - Category (3) - Field (4) - DataType (5) - MediaPool (6) - Media (7) - IndexingProfile (8) - SpoolType (9) - Query (10) - User (11) - Group (12) - CaptureProfile (13) - PreProcessor (14) - COLDForm (15) - QueryTemplate (16) - Folder (17) - LoaderProfile (18) - WorkflowProcess (19) - WorkflowTask (20) - WorkflowInstance (21) - KeyDict (22) - StoragePolicy (23) - Device (24) - StorageArea (25) - RetentionPolicy (26) - Count (27) - UniversalConnectorProfile (29) - CaseDefinition (37) - Case (38) - Stamp (40) - ReportDefinition (41) - eForm (47) - eFormSubmission (48) - FormImage (99) - Keyword (100) - Migrate (101) - Connectors (900) - StorageCtgry (901) - ServerMediaPools (902) - StorageAreaMedia (903) - ServerDevices (904) - ServerMedia (905) - TheSystem (1000) - COLD (1001) - ExchangeConnector (1002) - LotusConnector (1003) - SAPConnector (1004)	Sets the type of the object.
■ SubObjNo	xs:int		Sets the sub object number of the object. This is used for categories only.
□ UserName	xs:string	nillable	Sets name of the user (if Domains list is null or empty) OR Sets user query string specifying conditions for the desired users (if Domains list is set).
■ UserType		restriction enum (xs:string) - FindUsersInActiveDirectory (1) - FindUsersInTherefore (4) - FindAllUsers (5) - FindUsersNotInTherefore (32) - FindGroupsInActiveDirectory (64) - FindGroupsInTherefore (256) - FindAllGroups (320) - FindAllUsersAndGroups (325) - FindGroupsNotInTherefore (1024) - FindSMTPUsersOnly (4096)	Sets type of the user.
□ Domains		nillable	Sets list of the names of domains to search in.
≡ DomainName	xs:string	list nillable

Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetPermissionsResponse

Element Name	Element Type	Restrictions	Description
■ parameters
□ Permissions		mandatory nillable	Gets permissions.
≡ WSPermission		list nillable
■ Allowed	xs:boolean		Gets whether permission is allowed.
■ Denied	xs:boolean		Gets whether permission is denied.
■ InheritAllowed	xs:boolean		Gets information indicating if the Allow permission is inherited.
■ InheritDenied	xs:boolean		Gets information indicating if the Deny permission is inherited.
□ Name	xs:string	nillable	Gets the localized name of the permission.
■ Value	xs:unsignedLong		Get permission integer code. To get the list of codes use the GetPermissionConstants WebAPI operation.

Legend:

■	Not nillable element.
□	Nillable element.
≡	List of elements.
Bold	Mandatory element.