OSID Logo
OSID Specifications
authentication keys package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authentication.keys.Key
Implementsosid.OsidObject
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.Idthe agent Id
CompliancemandatoryThis method must be implemented.
MethodgetAgent
Description

Gets the Agent corresponding to this key.

Returnosid.authentication.Agentthe agent
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis 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.TypekeyRecordTypea key record type
Returnosid.authentication.keys.records.KeyRecordthe key record
ErrorsNULL_ARGUMENT keyRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(keyRecordType) is false
CompliancemandatoryThis method must be implemented.