OSID Logo
OSID Specifications
authentication keys package
Version 3.1.0
Interfaceosid.authentication.keys.Key
Implementsosid.OsidObject
Used Byosid.authentication.keys.KeyAdminSession
osid.authentication.keys.KeyList
osid.authentication.keys.KeyLookupSession
Description

The key represents cryptographic data managed by the authentication service. An Agent maps to a Key and there is only one Key per Agent.

MethodgetAgentId
Description

Gets the AgentId corresponding to this key.

Returnosid.id.Id the agent Id
Compliancemandatory This method must be implemented.
MethodgetAgent
Description

Gets the Agent corresponding to this key.

Returnosid.authentication.Agent the agent
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetKeyRecord
Description

Gets the key record corresponding to the given Key record Type.This method is used to retrieve an object implementing the requested record. The keyRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(keyRecordType) is true.

Parametersosid.type.TypekeyRecordType a key record type
Returnosid.authentication.keys.records.KeyRecord the key record
ErrorsNULL_ARGUMENT keyRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(keyRecordType) is false
Compliancemandatory This method must be implemented.