# Class: DocumentRoot

## tibco.objectapi.de.security.DocumentRoot

#### new DocumentRoot()

Constructs a new DocumentRoot.

The following features are supported:

- `Authenticate User`
- `Authenticate User Response`
- `Get User Privileges`
- `Get User Privileges Response`
- `Is Action Authorised`
- `Is Action Authorised Response`
- `List Action Authorised Entities`
- `List Action Authorised Entities Response`
- `List Authorised Orgs`
- `List Authorised Orgs Response`

### Members

#### authenticateUser :tibco.objectapi.de.security.AuthenticateUserType

Request element for authenticateUser operation. This operation is deprecated and should no longer be used. It is only available for backward compatibility and may be removed in future releases. This property holds the value of the 'Authenticate User' containment reference.

##### Type:

- tibco.objectapi.de.security.AuthenticateUserType

#### authenticateUserResponse :tibco.objectapi.de.security.AuthenticateUserResponseType

Response element for authenticateUser operation. This property holds the value of the 'Authenticate User Response' containment reference.

##### Type:

- tibco.objectapi.de.security.AuthenticateUserResponseType

#### getUserPrivileges :tibco.objectapi.de.security.GetUserPrivilegesType

Request element for getUserPrivileges operation. Returns the privileges held by the resource identified by its GUID. Resources inherit privileges from the organization units, positions and groups with which they are associated. For those privileges that are qualified, the response will include the qualifierSet that gives the qualifying value that applies. This property holds the value of the 'Get User Privileges' containment reference.

##### Type:

- tibco.objectapi.de.security.GetUserPrivilegesType

#### getUserPrivilegesResponse :tibco.objectapi.de.security.GetUserPrivilegesResponseType

Response element for getUserPrivileges operation. This property holds the value of the 'Get User Privileges Response' containment reference.

##### Type:

- tibco.objectapi.de.security.GetUserPrivilegesResponseType

#### isActionAuthorised :tibco.objectapi.de.security.IsActionAuthorisedType

Request element for isActionAuthorised operation. This operation tests whether the caller (as identified by the SOAP security header) is authorized to perform the specified system actions within the scope of the specified organization model entity. Each specified system action is tested individually. This property holds the value of the 'Is Action Authorised' containment reference.

##### Type:

- tibco.objectapi.de.security.IsActionAuthorisedType

#### isActionAuthorisedResponse :tibco.objectapi.de.security.IsActionAuthorisedResponseType

Response element for isActionAuthorised operation. This property holds the value of the 'Is Action Authorised Response' containment reference.

##### Type:

- tibco.objectapi.de.security.IsActionAuthorisedResponseType

#### listActionAuthorisedEntities :tibco.objectapi.de.security.ListActionAuthorisedEntitiesType

Request element for listActionAuthorisedEntities operation. This operation returns a list of organization model entities (identified by their GUID) on which the caller (determined by the security context) is authorized to perform the named system action. This is an expensive operation as it involves traversing the entire structure of all versions of the organizational model. This property holds the value of the 'List Action Authorised Entities' containment reference.

##### Type:

- tibco.objectapi.de.security.ListActionAuthorisedEntitiesType

#### listActionAuthorisedEntitiesResponse :tibco.objectapi.de.security.ListActionAuthorisedEntitiesResponseType

Response element for listActionAuthorisedEntities operation. This property holds the value of the 'List Action Authorised Entities Response' containment reference.

##### Type:

- tibco.objectapi.de.security.ListActionAuthorisedEntitiesResponseType

#### listAuthorisedOrgs :tibco.objectapi.de.security.ListAuthorisedOrgsType

Request element for listAuthorisedOrgs operation. Identifies the system action against which the user's authorization is to be tested. The test will only verify the system action to the organization level. If the system action can be scoped to a lower organization-entity level, such as organization unit or position, the test will not verify whether the user has authorization at those levels. In those cases, an additional "isActionAuthorised" test will be required before the action is performed. This property holds the value of the 'List Authorised Orgs' containment reference.

##### Type:

- tibco.objectapi.de.security.ListAuthorisedOrgsType

#### listAuthorisedOrgsResponse :tibco.objectapi.de.security.ListAuthorisedOrgsResponseType

Response element for listAuthorisedOrgs operation. This property holds the value of the 'List Authorised Orgs Response' containment reference.

##### Type:

- tibco.objectapi.de.security.ListAuthorisedOrgsResponseType