Kuali Authentication Service Contract Description

Owned by Tom Jones
Last updated: Jun 29, 2009 by Sanjay Dalal (Unlicensed)
4 min read
Authentication Service Home

Kuali Authentication Service

Unable to render {include} The included page could not be found.
Name Version Based upon
AuthenticationService
Dev Release Notes/History
KSS AuthenticationService

#References

#Operations

#Capabilities

Notes

References

/wiki/spaces/collectionspace/pages/666274319

/wiki/spaces/collectionspace/pages/666274494 and /wiki/spaces/collectionspace/pages/666274498 - entity page with fields and examples.
Authentication Stack Options - help understand how the Authentication service might interact with other service layers
PI Meeting Diagrams

Operations

Unable to render {include} The included page could not be found.
Setup

Dictionary Operations
#findObjectTypes
#fetchObjectStructure
#fetchEnumeration

Search Operations
#findSearchTypes
#fetchSearchType
#findSearchTypesByResult
#findSearchTypesByCriteria
#findSearchResultTypes
#fetchSearchResultType
#findSearchCriteriaTypes
#fetchSearchCriteriaType

Domain Operations
#findAuthenticationTypes

Read

(question) Need to add operation for fetchCurrentUser

#fetchPrincipal (plus) (question)
#findPrincipalsByIdList (plus) (question)

#fetchPrincipalDisplayInfo (plus) (question)
#findPrincipalDisplayInfoByIdList (plus) (question)

#findPrincipalIdsByPerson
#findPrincipalIdsBySystem

#fetchPersonIdByPrincipal
#fetchSystemIdByPrincipal (warning) Changed Service to System
#fetchPrincipalTypeForPrincipal

#findPrincipalTypesByPrincipalIdList (plus)

Search

#searchForResults

Maintenance

#assignPrincipalToPerson
#assignPrincipalToSystem (warning) Changed Service to System
#removePrincipalFromPerson
#removePrincipalFromSystem (warning) Changed Service to System

Setup

Method Description Parameters Return Errors Capabilities Use Cases Comments/Feedback
findObjectTypes
Retrieves the list of object type identifiers known by this service. Example: cluInfo.
None None No parameters
/wiki/spaces/collectionspace/pages/666274931 list of object type identifiers
OPERATION_FAILED unable to complete request

Back to Operations

Method Description Parameters Return Errors Capabilities Use Cases Comments/Feedback
fetchObjectStructure
Retrieves the basic dictionary information about a particular object structure. Including all variations based on a certain type and state. Example: Given that a CLU is of type "Course" and in the state of "Proposed," tell which fields are read only, mandatory, not applicable, have enumerations available, etc.
/wiki/spaces/collectionspace/pages/666274955 objectTypeKey identifier of the object type
/wiki/spaces/collectionspace/pages/666274927 describes the fields for the input object type
DOES_NOT_EXIST specified objectTypeKey not found
INVALID_PARAMETER invalid objectTypeKey
MISSING_PARAMETER missing objectTypeKey
OPERATION_FAILED unable to complete request

Back to Operations

Method Description Parameters Return Errors Capabilities Use Cases Comments/Feedback
fetchEnumeration
Retrieves the list of enumeration values for a particular enumeration with a certain context for a particular date. The values returned should be those where the supplied date is between the effective and expiration dates. Certain enumerations may not support this functionality.
/wiki/spaces/collectionspace/pages/666274894 enumerationKey identifier of the enumeration
/wiki/spaces/collectionspace/pages/666274903 contextType identifier of the enumeration context type
/wiki/spaces/collectionspace/pages/666274808 contextValue value of the enumeration context
/wiki/spaces/collectionspace/pages/666274812 contextDate date and time to get the enumeration for
/wiki/spaces/collectionspace/pages/666274883 list of enumerated codes and values
DOES_NOT_EXIST enumerationKey not found
INVALID_PARAMETER invalid enumerationKey, contextType, contextValue, contextDate
MISSING_PARAMETER missing enumerationKey, contextType, contextValue, contextDate
OPERATION_FAILED unable to complete request

Back to Operations

Method Description Parameters Return Errors Capabilities Use Cases Comments/Feedback
findSearchTypes
Retrieves the list of search types known by this service.
None None No Parameters
/wiki/spaces/collectionspace/pages/666274914 list of search type information
OPERATION_FAILED unable to complete request

Back to Operations

Method Description Parameters Return Errors Capabilities Use Cases Comments/Feedback
fetchSearchType
Retrieves information about a particular search type.
/wiki/spaces/collectionspace/pages/666275028 searchTypeKey identifier of the search type
/wiki/spaces/collectionspace/pages/666274920 information on the search type
DOES_NOT_EXIST specified searchTypeKey not found
INVALID_PARAMETER invalid searchTypeKey
MISSING_PARAMETER searchTypeKey not specified
OPERATION_FAILED unable to complete request

Back to Operations

Method Description Parameters Return Errors Capabilities Use Cases Comments/Feedback
findSearchTypesByResult
Retrieves the list of search types which return results in the specified format.
/wiki/spaces/collectionspace/pages/666275032 searchResultTypeKey identifier of the search result type
/wiki/spaces/collectionspace/pages/666274914 list of search type information
DOES_NOT_EXIST specified searchResultTypeKey not found
INVALID_PARAMETER invalid searchResultTypeKey
MISSING_PARAMETER searchResultTypeKey not specified
OPERATION_FAILED unable to complete request

Back to Operations

Method Description Parameters Return Errors Capabilities Use Cases Comments/Feedback
findSearchTypesByCriteria
Retrieves the list of search types which use criteria in the specified format.
/wiki/spaces/collectionspace/pages/666275018 searchCriteriaTypeKey identifier of the search criteria
/wiki/spaces/collectionspace/pages/666274914 list of search type information
DOES_NOT_EXIST specified searchCriteriaTypeKey not found
INVALID_PARAMETER invalid searchCriteriaTypeKey
MISSING_PARAMETER searchCriteriaTypeKey not specified
OPERATION_FAILED unable to complete request

Back to Operations

Method Description Parameters Return Errors Capabilities Use Cases Comments/Feedback
findSearchResultTypes
Retrieves the list of search result types known by this service. Search result types describe the return structure for a search.
None None No Parameters
/wiki/spaces/collectionspace/pages/666275023 list of search result type information
OPERATION_FAILED unable to complete request

Back to Operations

Method Description Parameters Return Errors Capabilities Use Cases Comments/Feedback
fetchSearchResultType
Retrieves information about a particular search result type. Search result types describe the return structure for a search.
/wiki/spaces/collectionspace/pages/666275032 searchResultTypeKey identifier of the search result type
/wiki/spaces/collectionspace/pages/666274906 information on the search result type
DOES_NOT_EXIST specified searchResultTypeKey not found
INVALID_PARAMETER invalid searchResultTypeKey
MISSING_PARAMETER searchResultTypeKey not specified
OPERATION_FAILED unable to complete request

Back to Operations

Method Description Parameters Return Errors Capabilities Use Cases Comments/Feedback
findSearchCriteriaTypes
Retrieves the list of search criteria types known by this service.
None None No parameters
/wiki/spaces/collectionspace/pages/666274979 list of search criteria type information
OPERATION_FAILED unable to complete request

Back to Operations

Method Description Parameters Return Errors Capabilities Use Cases Comments/Feedback
fetchSearchCriteriaType
Retrieves information about a particular search criteria type.
/wiki/spaces/collectionspace/pages/666275018 searchCriteriaTypeKey identifier of the search criteria type
/wiki/spaces/collectionspace/pages/666274965 information on the search criteria type
DOES_NOT_EXIST specified searchCriteriaTypeKey not found
INVALID_PARAMETER invalid searchCriteriaTypeKey
MISSING_PARAMETER searchCriteriaTypeKey not specified
OPERATION_FAILED unable to complete request

Back to Operations

Method Description Parameters Return Errors Capabilities Use Cases Comments/Feedback
findAuthenticationTypes
Retrieve the list of authentication types known by this service
None None No parameters
/wiki/spaces/collectionspace/pages/666274728 list of authentication types
OPERATION_FAILED unable to complete request

Back to Operations

Read

Method Description Parameters Return Errors Capabilities Use Cases Comments/Feedback
findPrincipalIdsByPerson
Retrieves a list of Principals for a given Person
/wiki/spaces/collectionspace/pages/666275074 personId person identifier
/wiki/spaces/collectionspace/pages/666274736 list of principal ids for the specified person
DISABLED_IDENTIFIER personId found but has been retired
DOES_NOT_EXIST personId not found
INVALID_PARAMETER invalid personId
MISSING_PARAMETER missing personId
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure

Back to Operations

Method Description Parameters Return Errors Capabilities Use Cases Comments/Feedback
findPrincipalIdsBySystem
Retrieves a list of Principals for a given System
/wiki/spaces/collectionspace/pages/666274703 systemId system identifier
/wiki/spaces/collectionspace/pages/666274736 list of principal ids for the given system
DISABLED_IDENTIFIER systemId found but has been retired
DOES_NOT_EXIST systemId not found
INVALID_PARAMETER invalid systemId
MISSING_PARAMETER missing systemId
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure

Back to Operations

Method Description Parameters Return Errors Capabilities Use Cases Comments/Feedback
fetchPersonIdByPrincipal
Retrieves a Person for a given Principal
/wiki/spaces/collectionspace/pages/666274739 principalId principal identifier
/wiki/spaces/collectionspace/pages/666275074 person identifier that matches the supplied criteria
DISABLED_IDENTIFIER principalId found but has been retired
DOES_NOT_EXIST principalId not found
INVALID_PARAMETER invalid principalId
MISSING_PARAMETER missing principalId
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure

Back to Operations

Method Description Parameters Return Errors Capabilities Use Cases Comments/Feedback
fetchSystemByPrincipal
Retrieves a System for a given Principal
/wiki/spaces/collectionspace/pages/666274739 principalId principal identifier
/wiki/spaces/collectionspace/pages/666274703 system identifier that matches the supplied criteria
DISABLED_IDENTIFIER systemId found but has been retired
DOES_NOT_EXIST systemId not found
INVALID_PARAMETER invalid principalId
MISSING_PARAMETER missing principalId
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure

Back to Operations

Method Description Parameters Return Errors Capabilities Use Cases Comments/Feedback
fetchPrincipalTypeForPrincipal
Retrieves a Principal Type for a given Principal
/wiki/spaces/collectionspace/pages/666274739 principalId principal identifier
/wiki/spaces/collectionspace/pages/666274690 principal type that matches the supplied criteria
DISABLED_IDENTIFIER principalId found but has been retired
DOES_NOT_EXIST principalId not found
INVALID_PARAMETER invalid principalId
MISSING_PARAMETER missing principalId
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure

Back to Operations

Method Description Parameters Return Errors Capabilities Use Cases Comments/Feedback
findPrincipalTypesByPrincipalIdList
Retrieves a list of Principal Types for a given list of Principal Ids
/wiki/spaces/collectionspace/pages/666274736 principalIdList list of principal identifiers
/wiki/spaces/collectionspace/pages/666274684 List of principal types that match the supplied criteria
DISABLED_IDENTIFIER One or more principalIds found but have been retired
DOES_NOT_EXIST One or more principalIds not found
INVALID_PARAMETER invalid principalIdList
MISSING_PARAMETER missing principalId
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure

Back to Operations

Method Description Parameters Return Errors Capabilities Use Cases Comments/Feedback
searchForResults
Retrieves results in tabular form for the specified parameters.
/wiki/spaces/collectionspace/pages/666275028 searchTypeKey search identifier
/wiki/spaces/collectionspace/pages/666275094 queryParamValues list of values for search parameters
/wiki/spaces/collectionspace/pages/666275096 list of results from the query
DOES_NOT_EXIST specified search type not found
INVALID_PARAMETER invalid searchTypeKey, queryParamValueList
MISSING_PARAMETER searchTypeKey, queryParamValueList not specified
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure

Back to Operations

Maintenance

Method Description Parameters Return Errors Capabilities Use Cases Comments/Feedback
assignPrincipalToPerson
Assigns a Principal to a Person
/wiki/spaces/collectionspace/pages/666274739 principalId principal identifier
/wiki/spaces/collectionspace/pages/666275074 personId person identifier
/wiki/spaces/collectionspace/pages/666275040 status of the operation
ALREADY_EXISTS association already exists
DISABLED_IDENTIFIER personId or principalId found but has been retired
DOES_NOT_EXIST personId, principalId does not exist
INVALID_PARAMETER invalid personId, principalId
MISSING_PARAMETER missing personId, principalId
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure

Back to Operations

Method Description Parameters Return Errors Capabilities Use Cases Comments/Feedback
assignPrincipalToSystem
Assigns a Principal to a System
/wiki/spaces/collectionspace/pages/666274739 principalId principal identifier
/wiki/spaces/collectionspace/pages/666274703 systemId system identifier
/wiki/spaces/collectionspace/pages/666275040 status of the operation
ALREADY_EXISTS association already exists
DISABLED_IDENTIFIER principalId, systemId found but has been retired
DOES_NOT_EXIST principalId, systemId does not exist
INVALID_PARAMETER invalid principalId, systemId
MISSING_PARAMETER missing principalId, systemId
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure

Back to Operations

Method Description Parameters Return Errors Capabilities Use Cases Comments/Feedback
removePrincipalFromPerson
Remove a Principal from a Person
/wiki/spaces/collectionspace/pages/666274739 principalId principal identifier
/wiki/spaces/collectionspace/pages/666275074 personId person identifier
/wiki/spaces/collectionspace/pages/666275040 status of the operation
DISABLED_IDENTIFIER personId or principalId found but has been retired
DOES_NOT_EXIST personId, principalId, association does not exist
INVALID_PARAMETER invalid personId, principalId
MISSING_PARAMETER missing personId, principalId
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure

Back to Operations

Method Description Parameters Return Errors Capabilities Use Cases Comments/Feedback
removePrincipalFromSystem
Remove a Principal from a System
/wiki/spaces/collectionspace/pages/666274739 principalId principal identifier
/wiki/spaces/collectionspace/pages/666274703 systemId system identifier
/wiki/spaces/collectionspace/pages/666275040 status of the operation
DISABLED_IDENTIFIER principalId, systemId found but has been retired
DOES_NOT_EXIST principalId, systemId, association does not exist
INVALID_PARAMETER invalid principalId, systemId
MISSING_PARAMETER missing principalId, systemId
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure

Back to Operations

Capabilities