AccessControlGetOwnerCandidates Method (ConnectionId, SessionId, Int32, CSSecurableObjects) Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Gets the trustees that can take ownership over a securable Content Studio object. Call this method to get a list of trustees that can act as owner of an object before attempting to take ownership of that object. The method calculates the possible owners of an object with respect to the calling user.

Namespace: ContentStudio.Security
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax

public string GetOwnerCandidates(
	ConnectionId connectionId,
	SessionId sessionId,
	int objectId,
	CSSecurableObjects objectType
)

Parameters

connectionId
Type: ContentStudioConnectionId
A value that identifies the web site
sessionId
Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).
objectId
Type: SystemInt32
An identifier to the securable object to take ownership for.
objectType
Type: ContentStudio.SecurityCSSecurableObjects
The type of object referred to by the ObjectID parameter.

Return Value

Type: String
Xml
Examples

This method returns the following Xml syntax
<root>
 <status>0</status>
 <statustext>Success</statustext>
 <trustees>
  <trustee id="12">
   <name>Everyone</name>
   <type>G</type>
   <sid format="s">S-1-1-0</sid>
   <isgroup>1</isgroup>
   <islocalgroup>1</islocalgroup>
  </trustee>
  <!-- more trustees can follow -->
 </trustees>
</root>
Exceptions

ExceptionCondition
CSExceptionA business rule was violated in the underlying Content Studio database
CSInvalidSessionExceptionThe session is invalid
CSInvalidParameterExceptionA parameter has an invalid value
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions

GlobalGroupAdmin rights or TakeOwnership permission on the object in question is required in order to receive any trustees.
See Also

Reference