pp108 : GetPrincipalOfUser

GetPrincipalOfUser

This method returns the principal assignment of a user.

SOAP Request

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP:Body>
        <GetPrincipalOfUser xmlns="http://schemas.cordys.com/userassignment/UserAssignmentService/1.0">
            <WorkspaceID>002481F0-8E9F-11E2-EE36-A5EED1105F38</WorkspaceID>
            <AssignmentRoot>[Assignment Root]</AssignmentRoot>
            <UserDN>cn=tester2,cn=organizational users,o=system,cn=cordys,o=orr.com</UserDN>
            <EffectiveOnly>false</EffectiveOnly>
        </GetPrincipalOfUser>
    </SOAP:Body>
</SOAP:Envelope>

Request Parameters

Parameter

Description

Mandatory

Accepted Input Value

WorkspaceID

Unique and valid ID of the Collaborative Workspace (CWS)

No

GUID or null

assignmentRoot

Assignment root ID. GUID retrieved from InitializeAssignmentRoot must be used.

Yes

GUID

UserDN

Distinguished name of the user for which assignments are retrieved. If empty, returns assignments for all users.

Yes

Distinguished Name of the user. For example, cn=cordysuser,cn=organizational users,o=development,cn=cordys,cn=build1,o=vanenburg.com.

EffectiveOnly

Effectiveness of assignments

Yes

If the value provided is:

  • true - command returns effective assignments only
  • false - command returns all assignments

SOAP Response

<GetPrincipalOfUserResponse xmlns="http://schemas.cordys.com/userassignment/UserAssignmentService/1.0">
  <GetPrincipalOfUser>
    <dataset xmlns="http://schemas.cordys.com/userassignment/UserAssignmentService/1.0">
      <tuple>
        <old>
          <Assignment xmlns="http://schemas.cordys.com/userassignment/UserAssignmentService/1.0">
            <ID>001CC438-906D-11E2-EECC-951E26303F4B</ID>
            <UserDN>cn=tester1,cn=organizational users,o=system,cn=cordys,o=orr.com</UserDN>
            <EffectiveDate>2013-02-13T00:00:00.0000</EffectiveDate>
            <FinishDate>2013-02-22T05:36:00.800</FinishDate>
            <IsPrincipalUnit>true</IsPrincipalUnit>
            <IsEffective>yes</IsEffective>
            <UnitID>001CC438-906D-11E2-EECC-49936ED1DF4B</UnitID>
            <QName>teams/college</QName>
            <Name>001CC438-906D-11E2-EECC-49936ED1DF4B</Name>
            <RoleDN>cn=professor,cn=organizational roles,o=system,cn=cordys,o=orr.com</RoleDN>
            <UnitRoleID>001CC438-906D-11E2-EECC-951E262FFF4B</UnitRoleID>
            <IsLeadRole>true</IsLeadRole>
            <AssignmentRoot>[Assignment Root]</AssignmentRoot>
          </Assignment>
        </old>
      </tuple>
    </dataset>
  </GetPrincipalOfUser>
</GetPrincipalOfUser>
Response Parameters

Parameter

Description

ID

ID of an Assignment (GUID)

UserDN

DN of User cn=$userName,cn=organizational users,o=system,cn=cordys,cn=$instanceName,o=$domain

EffectiveDate

Date on which the assignment starts. If there is no start date, the effective date is taken as the default date.

FinishDate

Date on which the assignment ends. If there is no finish date, the assignment does not end.

IsPrincipalUnit

Given unit is the principal unit of the user or not (true or false)

IsEffective

Assignment is effective based on the calculations from the effectiveDate and the finishDate (true or false)

UnitID

ID of the organization unit
QName Fully Qualified Name (FQN) of the organization unit
Name Name of the organization unit

RoleDN

Distinguished name of the role cn=My_role,cn=my-isvp,cn=cordys,cn=Env1,o=cordys.com

UnitRoleID

ID of the unit-role combination

IsLeadRole

Given role is lead role of this organization unit or not (true or false)

AssignmentRoot

ID of the Assignment root