Oracle Beehive
  Oracle® Beehive RESTful Web Services API Reference
  Release 2 (2.0.1.7)
  E16658-04

Contents

Overview

Specifies a user in the context of an organizational hierarchy.

Members

Name Type Required Description

accessibleWorkspaces

workspace[]

Workspaces accessible to the user via direct or indirect membership in the workspace.

activePreferenceProfile

preferenceProfile

Active preference profile of the accessor.

addresses

entityAddress[]

Addresses of the accessor.

assignedRoles

assignedRole[]

Roles assigned to this base accessor.

assistant

organizationUser

Assistant of this organization user.

attachedMarkers

marker[]

Set of marker elements associated with the entity.

attachedReminders

reminder[]

List of reminders attached to the entity

attachedSubscriptions

subscription[]

List of subscriptions attached to the entity

availablePreferenceProfiles

preferenceProfile[]

All the available preference profiles for this accessor.

bonds

bond[]

Bonds for this base accessor.

collabId

beeId

CollabId of the snapshot

company

string

Company.

createdOn

dateTime

Entity's creation date

creator

actor

The actor that created this entity

dataSourceIdentifier

string

Identifier of the external data source (directory) for the user.

dataSourceUserIdentifier

string

Identifier of the user within the external data source (directory).

deleted

boolean

Deletion flag. If this property is set to true the entity is deleted.

department

string

Organizational department.

directReports

organizationUser[]

Organization users that report to this organization user.

effectiveExternalInbox

boolean

Whether the user has an effective external inbox or not.

effectiveGroups

group[]

Groups that this base accessor is a member of, directly or indirectly (via sub-grouping).

extendedEnterpriseUser

boolean

Whether the user is an extended enterprise user or not.

externalInbox

boolean

Whether the user has an external inbox folder.

familyName

string

Family name.

familyNames

lString

Locale specific family names.

givenName

string

Given name of the user.

givenNames

lString

Locale specific given names.

groups

group[]

Groups that this base accessor is a direct member of.

jobTitle

string

Job title.

jobTitles

lString

Locale specific job titles.

locale

string

Preferred locale.

manager

user

Manager of this organization user.

middleName

string

Middle name.

middleNames

lString

Locale specific middle names.

modifiedBy

actor

The actor that last modified the entity

modifiedOn

dateTime

The date when entity was last modified

name

string

Name of the entity.

names

lString

Locale specific display names.

nickname

string

Nickname.

nicknames

lString

Locale specific nick names.

officeLocation

string

User's office location.

parent

entity

The parent for this entity.

personalWorkspace

personalWorkspace

The personal workspace of the user.

prefix

string

Name prefix.

prefixes

lString

Locale specific name prefixes.

presenceId

beeId<presence>

Presence id of this organization user

primaryAddress

entityAddress

Primary address of the accessor.

principals

principal[]

Principals of this actor.

profession

string

Profession.

properties

collabProperties

Properties for this accessor.

snapshotId

string

Contains the snapshot identifier for this snapshot. Snapshot identifiers are used to implement optimistic locking on the server.

status

provisioningStatus

Provisioning status of this actor.

suffix

string

Name suffix.

suffixes

lString

Locale specific name suffixes.

timeZoneModified

boolean

Whether the time zone has been modified by the user or not.

Hierarchy

Inherits From

Applied Markers

Examples

Below are examples in JSON and XML formats. All examples are shown with all inherited members. Quoting when required is part of the examples, but you must obviously populate with your own data.

XML Example

(show inherited members)

<obh:organizationUser xsi:type="obh:organizationUser" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:accessibleWorkspaces>your_workspace_0</obh:accessibleWorkspaces>
        <obh:accessibleWorkspaces>your_workspace_1</obh:accessibleWorkspaces>
        <obh:accessibleWorkspaces>your_workspace_2</obh:accessibleWorkspaces>
        <obh:activePreferenceProfile>your_preferenceProfile_0</obh:activePreferenceProfile>
        <obh:addresses>your_entityAddress_0</obh:addresses>
        <obh:addresses>your_entityAddress_1</obh:addresses>
        <obh:addresses>your_entityAddress_2</obh:addresses>
        <obh:assignedRoles>your_assignedRole_0</obh:assignedRoles>
        <obh:assignedRoles>your_assignedRole_1</obh:assignedRoles>
        <obh:assignedRoles>your_assignedRole_2</obh:assignedRoles>
        <obh:assistant>your_organizationUser_0</obh:assistant>
        <obh:attachedMarkers>your_marker_0</obh:attachedMarkers>
        <obh:attachedMarkers>your_marker_1</obh:attachedMarkers>
        <obh:attachedMarkers>your_marker_2</obh:attachedMarkers>
        <obh:attachedReminders>your_reminder_0</obh:attachedReminders>
        <obh:attachedReminders>your_reminder_1</obh:attachedReminders>
        <obh:attachedReminders>your_reminder_2</obh:attachedReminders>
        <obh:attachedSubscriptions>your_subscription_0</obh:attachedSubscriptions>
        <obh:attachedSubscriptions>your_subscription_1</obh:attachedSubscriptions>
        <obh:attachedSubscriptions>your_subscription_2</obh:attachedSubscriptions>
        <obh:availablePreferenceProfiles>your_preferenceProfile_0</obh:availablePreferenceProfiles>
        <obh:availablePreferenceProfiles>your_preferenceProfile_1</obh:availablePreferenceProfiles>
        <obh:availablePreferenceProfiles>your_preferenceProfile_2</obh:availablePreferenceProfiles>
        <obh:bonds>your_bond_0</obh:bonds>
        <obh:bonds>your_bond_1</obh:bonds>
        <obh:bonds>your_bond_2</obh:bonds>
        <obh:collabId>your_beeId_0</obh:collabId>
        <obh:company>your_string_0</obh:company>
        <obh:createdOn>your_dateTime_0</obh:createdOn>
        <obh:creator>your_actor_0</obh:creator>
        <obh:dataSourceIdentifier>your_string_0</obh:dataSourceIdentifier>
        <obh:dataSourceUserIdentifier>your_string_0</obh:dataSourceUserIdentifier>
        <obh:deleted>your_boolean_0</obh:deleted>
        <obh:department>your_string_0</obh:department>
        <obh:directReports>your_organizationUser_0</obh:directReports>
        <obh:directReports>your_organizationUser_1</obh:directReports>
        <obh:directReports>your_organizationUser_2</obh:directReports>
        <obh:effectiveExternalInbox>your_boolean_0</obh:effectiveExternalInbox>
        <obh:effectiveGroups>your_group_0</obh:effectiveGroups>
        <obh:effectiveGroups>your_group_1</obh:effectiveGroups>
        <obh:effectiveGroups>your_group_2</obh:effectiveGroups>
        <obh:extendedEnterpriseUser>your_boolean_0</obh:extendedEnterpriseUser>
        <obh:externalInbox>your_boolean_0</obh:externalInbox>
        <obh:familyName>your_string_0</obh:familyName>
        <obh:familyNames>your_lString_0</obh:familyNames>
        <obh:givenName>your_string_0</obh:givenName>
        <obh:givenNames>your_lString_0</obh:givenNames>
        <obh:groups>your_group_0</obh:groups>
        <obh:groups>your_group_1</obh:groups>
        <obh:groups>your_group_2</obh:groups>
        <obh:jobTitle>your_string_0</obh:jobTitle>
        <obh:jobTitles>your_lString_0</obh:jobTitles>
        <obh:locale>your_string_0</obh:locale>
        <obh:manager>your_user_0</obh:manager>
        <obh:middleName>your_string_0</obh:middleName>
        <obh:middleNames>your_lString_0</obh:middleNames>
        <obh:modifiedBy>your_actor_0</obh:modifiedBy>
        <obh:modifiedOn>your_dateTime_0</obh:modifiedOn>
        <obh:name>your_string_0</obh:name>
        <obh:names>your_lString_0</obh:names>
        <obh:nickname>your_string_0</obh:nickname>
        <obh:nicknames>your_lString_0</obh:nicknames>
        <obh:officeLocation>your_string_0</obh:officeLocation>
        <obh:parent>your_entity_0</obh:parent>
        <obh:personalWorkspace>your_personalWorkspace_0</obh:personalWorkspace>
        <obh:prefix>your_string_0</obh:prefix>
        <obh:prefixes>your_lString_0</obh:prefixes>
        <obh:presenceId>your_beeId_0</obh:presenceId>
        <obh:primaryAddress>your_entityAddress_0</obh:primaryAddress>
        <obh:principals>your_principal_0</obh:principals>
        <obh:principals>your_principal_1</obh:principals>
        <obh:principals>your_principal_2</obh:principals>
        <obh:profession>your_string_0</obh:profession>
        <obh:properties>your_collabProperties_0</obh:properties>
        <obh:snapshotId>your_string_0</obh:snapshotId>
        <obh:status>your_provisioningStatus_0</obh:status>
        <obh:suffix>your_string_0</obh:suffix>
        <obh:suffixes>your_lString_0</obh:suffixes>
        <obh:timeZoneModified>your_boolean_0</obh:timeZoneModified>
</obh:organizationUser>

JSON Example

(show inherited members)

{
    "beeType":"organizationUser",
        "accessibleWorkspaces":[
            { your_{http://www.oracle.com/beehive}accessibleWorkspaces_as_workspace0 },
            { your_{http://www.oracle.com/beehive}accessibleWorkspaces_as_workspace1 },
            { your_{http://www.oracle.com/beehive}accessibleWorkspaces_as_workspace2 }
        ],
        "activePreferenceProfile":{ your_{http://www.oracle.com/beehive}activePreferenceProfile_as_preferenceProfile0 },
        "addresses":[
            { your_{http://www.oracle.com/beehive}addresses_as_entityAddress0 },
            { your_{http://www.oracle.com/beehive}addresses_as_entityAddress1 },
            { your_{http://www.oracle.com/beehive}addresses_as_entityAddress2 }
        ],
        "assignedRoles":[
            { your_{http://www.oracle.com/beehive}assignedRoles_as_assignedRole0 },
            { your_{http://www.oracle.com/beehive}assignedRoles_as_assignedRole1 },
            { your_{http://www.oracle.com/beehive}assignedRoles_as_assignedRole2 }
        ],
        "assistant":{ your_{http://www.oracle.com/beehive}assistant_as_organizationUser0 },
        "attachedMarkers":[
            { your_{http://www.oracle.com/beehive}attachedMarkers_as_marker0 },
            { your_{http://www.oracle.com/beehive}attachedMarkers_as_marker1 },
            { your_{http://www.oracle.com/beehive}attachedMarkers_as_marker2 }
        ],
        "attachedReminders":[
            { your_{http://www.oracle.com/beehive}attachedReminders_as_reminder0 },
            { your_{http://www.oracle.com/beehive}attachedReminders_as_reminder1 },
            { your_{http://www.oracle.com/beehive}attachedReminders_as_reminder2 }
        ],
        "attachedSubscriptions":[
            { your_{http://www.oracle.com/beehive}attachedSubscriptions_as_subscription0 },
            { your_{http://www.oracle.com/beehive}attachedSubscriptions_as_subscription1 },
            { your_{http://www.oracle.com/beehive}attachedSubscriptions_as_subscription2 }
        ],
        "availablePreferenceProfiles":[
            { your_{http://www.oracle.com/beehive}availablePreferenceProfiles_as_preferenceProfile0 },
            { your_{http://www.oracle.com/beehive}availablePreferenceProfiles_as_preferenceProfile1 },
            { your_{http://www.oracle.com/beehive}availablePreferenceProfiles_as_preferenceProfile2 }
        ],
        "bonds":[
            { your_{http://www.oracle.com/beehive}bonds_as_bond0 },
            { your_{http://www.oracle.com/beehive}bonds_as_bond1 },
            { your_{http://www.oracle.com/beehive}bonds_as_bond2 }
        ],
        "collabId":{ your_{http://www.oracle.com/beehive}collabId_as_beeId0 },
        "company":"your_{http://www.oracle.com/beehive}company_as_string0",
        "createdOn":"your_{http://www.oracle.com/beehive}createdOn_as_dateTime0",
        "creator":{ your_{http://www.oracle.com/beehive}creator_as_actor0 },
        "dataSourceIdentifier":"your_{http://www.oracle.com/beehive}dataSourceIdentifier_as_string0",
        "dataSourceUserIdentifier":"your_{http://www.oracle.com/beehive}dataSourceUserIdentifier_as_string0",
        "deleted":your_{http://www.oracle.com/beehive}deleted_as_boolean0,
        "department":"your_{http://www.oracle.com/beehive}department_as_string0",
        "directReports":[
            { your_{http://www.oracle.com/beehive}directReports_as_organizationUser0 },
            { your_{http://www.oracle.com/beehive}directReports_as_organizationUser1 },
            { your_{http://www.oracle.com/beehive}directReports_as_organizationUser2 }
        ],
        "effectiveExternalInbox":your_{http://www.oracle.com/beehive}effectiveExternalInbox_as_boolean0,
        "effectiveGroups":[
            { your_{http://www.oracle.com/beehive}effectiveGroups_as_group0 },
            { your_{http://www.oracle.com/beehive}effectiveGroups_as_group1 },
            { your_{http://www.oracle.com/beehive}effectiveGroups_as_group2 }
        ],
        "extendedEnterpriseUser":your_{http://www.oracle.com/beehive}extendedEnterpriseUser_as_boolean0,
        "externalInbox":your_{http://www.oracle.com/beehive}externalInbox_as_boolean0,
        "familyName":"your_{http://www.oracle.com/beehive}familyName_as_string0",
        "familyNames":{ your_{http://www.oracle.com/beehive}familyNames_as_lString0 },
        "givenName":"your_{http://www.oracle.com/beehive}givenName_as_string0",
        "givenNames":{ your_{http://www.oracle.com/beehive}givenNames_as_lString0 },
        "groups":[
            { your_{http://www.oracle.com/beehive}groups_as_group0 },
            { your_{http://www.oracle.com/beehive}groups_as_group1 },
            { your_{http://www.oracle.com/beehive}groups_as_group2 }
        ],
        "jobTitle":"your_{http://www.oracle.com/beehive}jobTitle_as_string0",
        "jobTitles":{ your_{http://www.oracle.com/beehive}jobTitles_as_lString0 },
        "locale":"your_{http://www.oracle.com/beehive}locale_as_string0",
        "manager":{ your_{http://www.oracle.com/beehive}manager_as_user0 },
        "middleName":"your_{http://www.oracle.com/beehive}middleName_as_string0",
        "middleNames":{ your_{http://www.oracle.com/beehive}middleNames_as_lString0 },
        "modifiedBy":{ your_{http://www.oracle.com/beehive}modifiedBy_as_actor0 },
        "modifiedOn":"your_{http://www.oracle.com/beehive}modifiedOn_as_dateTime0",
        "name":"your_{http://www.oracle.com/beehive}name_as_string0",
        "names":{ your_{http://www.oracle.com/beehive}names_as_lString0 },
        "nickname":"your_{http://www.oracle.com/beehive}nickname_as_string0",
        "nicknames":{ your_{http://www.oracle.com/beehive}nicknames_as_lString0 },
        "officeLocation":"your_{http://www.oracle.com/beehive}officeLocation_as_string0",
        "parent":{ your_{http://www.oracle.com/beehive}parent_as_entity0 },
        "personalWorkspace":{ your_{http://www.oracle.com/beehive}personalWorkspace_as_personalWorkspace0 },
        "prefix":"your_{http://www.oracle.com/beehive}prefix_as_string0",
        "prefixes":{ your_{http://www.oracle.com/beehive}prefixes_as_lString0 },
        "presenceId":{ your_{http://www.oracle.com/beehive}presenceId_as_beeId0 },
        "primaryAddress":{ your_{http://www.oracle.com/beehive}primaryAddress_as_entityAddress0 },
        "principals":[
            { your_{http://www.oracle.com/beehive}principals_as_principal0 },
            { your_{http://www.oracle.com/beehive}principals_as_principal1 },
            { your_{http://www.oracle.com/beehive}principals_as_principal2 }
        ],
        "profession":"your_{http://www.oracle.com/beehive}profession_as_string0",
        "properties":{ your_{http://www.oracle.com/beehive}properties_as_collabProperties0 },
        "snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0",
        "status":{ your_{http://www.oracle.com/beehive}status_as_provisioningStatus0 },
        "suffix":"your_{http://www.oracle.com/beehive}suffix_as_string0",
        "suffixes":{ your_{http://www.oracle.com/beehive}suffixes_as_lString0 },
        "timeZoneModified":your_{http://www.oracle.com/beehive}timeZoneModified_as_boolean0
}

XML Schema


<xs:complexType name="organizationUser">
    <xs:complexContent>
        <xs:extension base="tns:user">
            <xs:sequence>
                <xs:element minOccurs="0" name="assistant" type="tns:organizationUser"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="directReports" type="tns:organizationUser"/>
                <xs:element minOccurs="0" name="manager" type="tns:user"/>
                <xs:element minOccurs="0" name="presenceId" type="tns:beeId"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

The following data represents the references to organizationUser

Referenced By Resources

Usage Resource Method
Response Current User Utilities Read My User
Response Organization User List
Response Organization User Read
Response Organization User Read Batch
Request Organization User Read Batch
Response Organization User Update

Referenced By Representaions