Authorization
An Authorization is a mapping among an actor, a
Function and a Qualifier.
This interface is not required for performing
authorization checks but is used for examining and
managing authorizations.
The actor of an authorization may be specified in a variety of forms.
-
Agent -
Resource: all theAgentsassociated with aResourcefor matching authorizations -
ResourceandTrust: all theAgentswithin a cicle ofTrustare used
An explicit Authorization represents
the mappings as they are directly managed in the
AuthorizationAdminSession. Implicit
authorizations may be retrieved which are
authorizations inferred through the
Function or Qualifier
hierarchies. An implicit Authorization is
one where isImplicit() is true and should
not be used for modification as it is only available
for auditing purposes.
An Authorization containing a
Resource may also provide the associated
Agent in a request for implicit authorizations or for
all the authorizations, both explicit and implicit,
for a given Agent.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Temporal | |||
isEffective |
boolean | true if this is effective, false otherwise |
|
startDate |
datetime | the start date | |
endDate |
datetime | the end date | |
| OsidRelationship | |||
hasEndReason |
boolean | true if an end reason is available, false
otherwise |
|
endReasonId |
id | a state Id |
|
endReason |
State | a state | |
| Name | Syntax | Many | Description |
|---|---|---|---|
isImplicit |
boolean | true if this authorization is implicit, false
otherwise |
|
hasResource |
boolean | true if this authorization has a Resource,
false otherwise |
|
resourceId |
id | the Resource Id |
|
resource |
Resource | the Resource |
|
hasTrust |
boolean | true if this authorization has a Trust,
false otherwise |
|
trustId |
id | the trust Id |
|
trust |
Trust | the Trust |
|
hasAgent |
boolean | true if this authorization has an Agent,
false otherwise |
|
agentId |
id | the Agent Id |
|
agent |
Agent | the Agent |
|
functionId |
id | the function Id |
|
function |
Function | the function | |
qualifierId |
id | the qualifier Id |
|
qualifier |
Qualifier | the qualifier |
Function
A Function represents an
authenticatable identity. Like all OSID objects, a
Function is identified by its
Id and any persisted references should
use the Id. A rule associated with the
Function specifies conditions that can be
supplied to authorization checks.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Operable | |||
isActive |
boolean | true if this operable is active, false if it is
inactive |
|
isEnabled |
boolean | true if this operable is enabled, false if the
active status is determined by other rules |
|
isDisabled |
boolean | true if this operable is disabled, false if the
active status is determined by other rules |
|
isOperational |
boolean | true if this operable is operational, false
otherwise |
|
| OsidRule | |||
hasRule |
boolean | true if an explicit rule is available, false
otherwise |
|
ruleId |
id | the rule Id |
|
rule |
Rule | the rule | |
conditionRecordTypes |
type | ⋆ | a list of OsidCondition record Types |
Qualifier
A Qualifier represents an
authenticatable identity. Like all OSID objects, a
Qualifier is identified by its
Id and any persisted references should
use the Id.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
Vault
A vault defines a collection of authorizations and functions.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Sourceable | |||
providerId |
id | the provider Id |
|
provider |
Resource | the provider | |
brandingIds |
id | ⋆ | a list of asset Ids |
branding |
Asset | ⋆ | a list of assets |
license |
displaytext | the license | |