OSID Logo
OSID Specifications
authentication package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authentication.AuthenticationProfile
Implementsosid.OsidProfile
Description

The AuthenticationProfile describes the interoperability among authentication services.

MethodsupportsVisibleFederation
Description

Tests if federation is visible.

Returnboolean true if visible federation is supported , false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAuthenticationAcquisition
Description

Tests is authentication acquisition is supported. Authentication acquisition is responsible for acquiring client side authentication credentials.

Returnboolean true if authentication acquisiiton is supported , false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAuthenticationValidation
Description

Tests if authentication validation is supported. Authentication validation verifies given authentication credentials and maps to an agent identity.

Returnboolean true if authentication validation is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAgentLookup
Description

Tests if an agent lookup service is supported. An agent lookup service defines methods to access agents.

Returnboolean true if agent lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAgentQuery
Description

Tests if an agent query service is supported.

Returnboolean true if agent query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAgentSearch
Description

Tests if an agent search service is supported.

Returnboolean true if agent search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAgentAdmin
Description

Tests if an agent administrative service is supported.

Returnboolean true if agent admin is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAgentNotification
Description

Tests if agent notification is supported. Messages may be sent when agents are created, modified, or deleted.

Returnboolean true if agent notification is supported , false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAgentAgency
Description

Tests if retrieving mappings of agents and agencies is supported.

Returnboolean true if agent agency mapping retrieval is supported , false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAgentAgencyAssignment
Description

Tests if managing mappings of agents and agencies is supported.

Returnboolean true if agent agency assignment is supported , false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAgentSmartAgency
Description

Tests if agent smart agency is available.

Returnboolean true if agent smart agency is supported , false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAgencyLookup
Description

Tests if an agency lookup service is supported. An agency lookup service defines methods to access agencies.

Returnboolean true if agency lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAgencyQuery
Description

Tests if an agency query service is supported.

Returnboolean true if agency query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAgencySearch
Description

Tests if an agency search service is supported.

Returnboolean true if agency search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAgencyAdmin
Description

Tests if an agency administrative service is supported.

Returnboolean true if agency admin is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAgencyNotification
Description

Tests if agency notification is supported. Messages may be sent when agencies are created, modified, or deleted.

Returnboolean true if agency notification is supported , false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAgencyHierarchy
Description

Tests if an agency hierarchy traversal is supported.

Returnboolean true if an agency hierarchy traversal is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAgencyHierarchyDesign
Description

Tests if an agency hierarchy design is supported.

Returnboolean true if an agency hierarchy design is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAuthenticationKeys
Description

Tests if an authentication key service is available.

Returnboolean true if an authentication key service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAuthenticationProcess
Description

Tests if an authentication process service is available.

Returnboolean true if an authentication process service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAgentRecordTypes
Description

Gets the supported Agent record types.

Returnosid.type.TypeLista list containing the supported Agent record types
CompliancemandatoryThis method must be implemented.
MethodsupportsAgentRecordType
Description

Tests if the given Agent record type is supported.

Parametersosid.type.TypeagentRecordTypea Type indicating an Agent record type
Returnboolean true if the given record Type is supported, false otherwise
ErrorsNULL_ARGUMENT agentRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetAgentSearchRecordTypes
Description

Gets the supported Agent search record types.

Returnosid.type.TypeLista list containing the supported Agent search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsAgentSearchRecordType
Description

Tests if the given Agent search record type is supported.

Parametersosid.type.TypeagentSearchRecordTypea Type indicating an Agent search record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT agentSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetAgencyRecordTypes
Description

Gets the supported Agency record types.

Returnosid.type.TypeLista list containing the supported Agency record types
CompliancemandatoryThis method must be implemented.
MethodsupportsAgencyRecordType
Description

Tests if the given Agency record type is supported.

Parametersosid.type.TypeagencyRecordTypea Type indicating an Agency record type
Returnboolean true if the given record Type is supported, false otherwise
ErrorsNULL_ARGUMENT agencyRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetAgencySearchRecordTypes
Description

Gets the supported Agency search record types.

Returnosid.type.TypeLista list containing the supported Agency search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsAgencySearchRecordType
Description

Tests if the given Agency search record type is supported.

Parametersosid.type.TypeagencySearchRecordTypea Type indicating an Agency search record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT agencySearchRecordType is null
CompliancemandatoryThis method must be implemented.