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

Beehive Development Kit » All Representations » principal
Contents

Overview

Specifies an accessor for authorization and impersonation purpose. A principal can correspond to one or many login id, password, PIN, biometric or certificate credentials of an actor.

Members

Name Type Required Description

activatingActorSufficient

boolean
Whether the activating actor is sufficient.

assignedRoles

assignedRole[]
Roles assigned to this base accessor.

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

bonds

bond[]
Bonds for this base accessor.

collabId

beeId
CollabId of the snapshot

createdOn

dateTime
Entity's creation date

creator

actor
The actor that created this entity

deleted

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

effectiveGroups

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

groups

group[]
Groups that this base accessor is a direct member of.

modifiedBy

actor
The actor that last modified the entity

modifiedOn

dateTime
The date when entity was last modified

name

string
Name of the entity.

parent

entity
The parent for this entity.

primary

boolean
Whether this is the primary principal for the parent.

principalType

principalType
Principal type.

snapshotId

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

sufficientPrincipals

principal[]
Sufficient principals.

Hierarchy

Inherits From

Inherited By

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:principal xsi:type="obh:principal" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:activatingActorSufficient>your_boolean_0</obh:activatingActorSufficient>
         <obh:assignedRoles>your_assignedRole_0</obh:assignedRoles>
        <obh:assignedRoles>your_assignedRole_1</obh:assignedRoles>
        <obh:assignedRoles>your_assignedRole_2</obh:assignedRoles>
         <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: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:createdOn>your_dateTime_0</obh:createdOn>
         <obh:creator>your_actor_0</obh:creator>
         <obh:deleted>your_boolean_0</obh:deleted>
         <obh:effectiveGroups>your_group_0</obh:effectiveGroups>
        <obh:effectiveGroups>your_group_1</obh:effectiveGroups>
        <obh:effectiveGroups>your_group_2</obh:effectiveGroups>
         <obh:groups>your_group_0</obh:groups>
        <obh:groups>your_group_1</obh:groups>
        <obh:groups>your_group_2</obh:groups>
         <obh:modifiedBy>your_actor_0</obh:modifiedBy>
         <obh:modifiedOn>your_dateTime_0</obh:modifiedOn>
         <obh:name>your_string_0</obh:name>
         <obh:parent>your_entity_0</obh:parent>
         <obh:primary>your_boolean_0</obh:primary>
         <obh:principalType>your_principalType_0</obh:principalType>
         <obh:snapshotId>your_string_0</obh:snapshotId>
         <obh:sufficientPrincipals>your_principal_0</obh:sufficientPrincipals>
        <obh:sufficientPrincipals>your_principal_1</obh:sufficientPrincipals>
        <obh:sufficientPrincipals>your_principal_2</obh:sufficientPrincipals>
 </obh:principal>

JSON Example

(show inherited members)

{
    "beeType":"principal",
        "activatingActorSufficient":your_{http://www.oracle.com/beehive}activatingActorSufficient_as_boolean0,
         "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 }
        ],
         "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 }
        ],
         "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 },
         "createdOn":"your_{http://www.oracle.com/beehive}createdOn_as_dateTime0",
         "creator":{ your_{http://www.oracle.com/beehive}creator_as_actor0 },
         "deleted":your_{http://www.oracle.com/beehive}deleted_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 }
        ],
         "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 }
        ],
         "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",
         "parent":{ your_{http://www.oracle.com/beehive}parent_as_entity0 },
         "primary":your_{http://www.oracle.com/beehive}primary_as_boolean0,
         "principalType":{ your_{http://www.oracle.com/beehive}principalType_as_principalType0 },
         "snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0",
         "sufficientPrincipals":[
            { your_{http://www.oracle.com/beehive}sufficientPrincipals_as_principal0 },
            { your_{http://www.oracle.com/beehive}sufficientPrincipals_as_principal1 },
            { your_{http://www.oracle.com/beehive}sufficientPrincipals_as_principal2 }
        ]
 }

XML Schema


<xs:complexType name="principal">
    <xs:complexContent>
        <xs:extension base="tns:baseAccessor">
            <xs:sequence>
                <xs:element name="activatingActorSufficient" type="xs:boolean"/>
                <xs:element name="primary" type="xs:boolean"/>
                <xs:element minOccurs="0" name="principalType" type="tns:principalType"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="sufficientPrincipals" type="tns:principal"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

References

The following data represents the references to principal

Referenced By Resources

Usage Resource Method
Response Principal Read
Response Principal Read Batch
Request Principal Read Batch
Response Principal Resolve

Referenced By Representaions

Oracle Logo
Copyright © 2008, 2012, Oracle and/or its affiliates. All rights reserved.
Legal Notices