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

This session provides methods to retrieve Authorization to Vault mappings. An Authorization may appear in multiple Vaults. 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
MethoduseComparativeVaultView
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.
MethodusePlenaryVaultView
Description

A complete view of the Authorization 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.
MethodcanLookupAuthorizationVaultMappings
Description

Tests if this user can perform lookups of authorization/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.
MethodgetAuthorizationIdsByVault
Description

Gets the list of Authorization Ids associated with a Vault.

Parametersosid.id.IdvaultId Id of a Vault
Returnosid.id.IdListlist of related authorization 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.
MethodgetAuthorizationsByVault
Description

Gets the list of Authorizations associated with a Vault.

Parametersosid.id.IdvaultId Id of a Vault
Returnosid.authorization.AuthorizationListlist of related authorization
ErrorsNOT_FOUND vaultId is not found
NULL_ARGUMENT vaultId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuthorizationsIdsByVault
Description

Gets the list of Authorization Ids corresponding to a list of Vault objects.

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

Gets the list of Authorizations corresponding to a list of Vault.

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

Gets the list of Vault Ids mapped to an Authorization.

Parametersosid.id.IdauthorizationId Id of an Authorization
Returnosid.id.IdListlist of vault Ids
ErrorsNOT_FOUND authorizationId is not found
NULL_ARGUMENT authorizationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetVaultByAuthorization
Description

Gets the list of Vault objects mapped to an Authorization.

Parametersosid.id.IdauthorizationId Id of an Authorization
Returnosid.authorization.VaultListlist of vault
ErrorsNOT_FOUND authorizationId is not found
NULL_ARGUMENT authorizationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.