OSID Logo
OSID Specifications
authorization rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.rules.AuthorizationEnablerVaultSession
Implementsosid.OsidSession
Description

This session provides methods to retrieve AuthorizationEnabler to Vault mappings. An AuthorizationEnabler may appear in multiple Vault objects. Each vault may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupAuthorizationEnablerVaultMappings
Description

Tests if this user can perform lookups of authorization enabler/vault mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeAuthorizationEnablerVaultView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryAuthorizationEnablerVaultView
Description

A complete view of the AuthorizationEnabler and Vault returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetAuthorizationEnablerIdsByVault
Description

Gets the list of AuthorizationEnablerIds associated with a Vault.

Parametersosid.id.IdvaultId Id of the Vault
Returnosid.id.IdListlist of related authorization enabler Ids
ErrorsNOT_FOUND vaultId is not found
NULL_ARGUMENT vaultId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuthorizationEnablersByVault
Description

Gets the list of authorization enablers associated with a Vault.

Parametersosid.id.IdvaultId Id of the Vault
Returnosid.authorization.rules.AuthorizationEnablerListlist of related authorization enablers
ErrorsNOT_FOUND vaultId is not found
NULL_ARGUMENT vaultId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuthorizationEnablerIdsByVaults
Description

Gets the list of AuthorizationEnabler Ids corresponding to a list of Vaults.

Parametersosid.id.IdListvaultIdslist of vault Ids
Returnosid.id.IdListlist of authorization enabler Ids
ErrorsNULL_ARGUMENT vaultIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuthorizationEnablersByVaults
Description

Gets the list of authorization enablers corresponding to a list of Vaults.

Parametersosid.id.IdListvaultIdslist of vault Ids
Returnosid.authorization.rules.AuthorizationEnablerListlist of authorization enablers
ErrorsNULL_ARGUMENT vaultIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetVaultIdsByAuthorizationEnabler
Description

Gets the Vault Ids mapped to an AuthorizationEnabler.

Parametersosid.id.IdauthorizationEnablerId Id of an AuthorizationEnabler
Returnosid.id.IdListlist of vaults
ErrorsNOT_FOUND authorizationEnablerId is not found
NULL_ARGUMENT authorizationEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetVaultsByAuthorizationEnabler
Description

Gets the Vaults mapped to an AuthorizationEnabler.

Parametersosid.id.IdauthorizationEnablerId Id of an AuthorizationEnabler
Returnosid.authorization.VaultListlist of vaults
ErrorsNOT_FOUND authorizationEnablerId is not found
NULL_ARGUMENT authorizationEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.