OSID Logo
OSID Specifications
authentication keys package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authentication.keys.KeyAgencySession
Implementsosid.OsidSession
Description

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

This lookup session defines two views:

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

Tests if this user can perform lookups of key/agency 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.
MethoduseComparativeAgencyView
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.
MethodusePlenaryAgencyView
Description

A complete view of the Key and Agency 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.
MethodgetKeyIdsByAgency
Description

Gets the list of Key Ids associated with an Agency.

Parametersosid.id.IdagencyId Id of the Agency
Returnosid.id.IdListlist of related key Ids
ErrorsNOT_FOUND agencyId is not found
NULL_ARGUMENT agencyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetKeysByAgency
Description

Gets the list of Keys associated with an Agency.

Parametersosid.id.IdagencyId Id of the Agency
Returnosid.authentication.keys.KeyListlist of related keys
ErrorsNOT_FOUND agencyId is not found
NULL_ARGUMENT agencyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetKeyIdsByAgencies
Description

Gets the list of Key Ids corresponding to a list of Agency objects.

Parametersosid.id.IdListagencyIdslist of agency Ids
Returnosid.id.IdListlist of key Ids
ErrorsNULL_ARGUMENT agencyIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetKeysByAgencies
Description

Gets the list of Keys corresponding to a list of Agency objects.

Parametersosid.id.IdListagencyIdslist of agency Ids
Returnosid.authentication.keys.KeyListlist of keys
ErrorsNULL_ARGUMENT agencyIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAgencyIdsByKey
Description

Gets the list of Agency Ids mapped to an Key.

Parametersosid.id.IdkeyId Id of an Key
Returnosid.id.IdListlist of agency Ids
ErrorsNOT_FOUND keyId is not found
NULL_ARGUMENT keyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAgenciesByKey
Description

Gets the list of Agency objects mapped to an Key.

Parametersosid.id.IdkeyId Id of an Key
Returnosid.authentication.AgencyListlist of agencies
ErrorsNOT_FOUND keyId is not found
NULL_ARGUMENT keyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.