OSID Logo
OSID Specifications
authentication keys batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authentication.keys.batch.AuthenticationKeysBatchManager
Implementsosid.OsidManager
osid.authentication.keys.batch.AuthenticationKeysBatchProfile
Description

The authentication keys batch manager provides access to authentication keys batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • KeyBatchAdminSession: a session to create, modify and delete keys in bulk
MethodgetKeyBatchAdminSession
Description

Gets the OsidSession associated with the bulk key administration service.

Returnosid.authentication.keys.batch.KeyBatchAdminSessiona KeyBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsKeyBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsKeyBatchAdmin() is true.
MethodgetKeyBatchAdminSessionForAgency
Description

Gets the OsidSession associated with the bulk key administration service for the given agency.

Parametersosid.id.IdagencyIdthe Id of the Agency
Returnosid.authentication.keys.batch.KeyBatchAdminSessiona KeyBatchAdminSession
ErrorsNOT_FOUNDno Agency found by the given Id
NULL_ARGUMENT agencyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsKeyBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsKeyBatchAdmin() and supportsVisibleFederation() are true