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

Contents

Overview

The RoleDefinition Entity.

A RoleDefinition is a set of Privileges to be granted, a set of AccessTypes to be granted, and a set of AccessTypes to be denied. A RoleDefinition by itself does not have any effect; it must be referenced from an AssignedRole for the Privileges and AccessTypes to take effect within a Scope specified by the AssignedRole.

A RoleDefinition can be marked AlwaysEnabled (meaning it is always enabled, by default, and can not be disabled). AssignedRoles using RoleDefinitions that are not marked AlwaysEnabled can be enabled through methods on the UserContext.

The following specifies which attributes are loaded when each Projection type is used to load a RoleDefinition snapshot:

Projection.EMPTY loads the following:

Projection.BASIC loads the Projection.EMPTY fields and the following: Projection.META loads Projection.Empty and Projection.BASIC fields and the following:

Projection.FULL does not load any additional fields.

The RoleDefinition's LocalACL (LACL) is managed using an AccessControlFieldsUpdater.

The RoleDefinition snapshot and the data it contains are immutable.

Members

Name Type Required Description

accessTypes

accessTypes

Returns the AccessTypes.

alwaysEnabled

boolean

Returns the always enabled status.

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

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.

description

string

Returns the Description.

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.

privileges

privilege[]

Returns the Privileges.

snapshotId

string

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

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:roleDefinition xsi:type="obh:roleDefinition" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:accessTypes>your_accessTypes_0</obh:accessTypes>
        <obh:alwaysEnabled>your_boolean_0</obh:alwaysEnabled>
        <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: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:description>your_string_0</obh:description>
        <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:privileges>your_privilege_0</obh:privileges>
        <obh:privileges>your_privilege_1</obh:privileges>
        <obh:privileges>your_privilege_2</obh:privileges>
        <obh:snapshotId>your_string_0</obh:snapshotId>
</obh:roleDefinition>

JSON Example

(show inherited members)

{
    "beeType":"roleDefinition",
        "accessTypes":{ your_{http://www.oracle.com/beehive}accessTypes_as_accessTypes0 },
        "alwaysEnabled":your_{http://www.oracle.com/beehive}alwaysEnabled_as_boolean0,
        "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 }
        ],
        "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,
        "description":"your_{http://www.oracle.com/beehive}description_as_string0",
        "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 },
        "privileges":[
            { your_{http://www.oracle.com/beehive}privileges_as_privilege0 },
            { your_{http://www.oracle.com/beehive}privileges_as_privilege1 },
            { your_{http://www.oracle.com/beehive}privileges_as_privilege2 }
        ],
        "snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0"
}

XML Schema


<xs:complexType final="extension restriction" name="roleDefinition">
    <xs:complexContent>
        <xs:extension base="tns:entity">
            <xs:sequence>
                <xs:element minOccurs="0" name="accessTypes" type="tns:accessTypes"/>
                <xs:element name="alwaysEnabled" type="xs:boolean"/>
                <xs:element minOccurs="0" name="description" type="xs:string"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="privileges" nillable="true" type="tns:privilege"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

The following data represents the references to roleDefinition

Referenced By Resources

Usage Resource Method
Response Role Definition Create
Response Role Definition List
Response Role Definition Read
Response Role Definition Read Batch
Request Role Definition Read Batch
Response Role Definition Update

Referenced By Representaions