Kuali Authentication Service Contract Description

Kuali Authentication Service

Name Version Based upon

AuthenticationService
Dev	Release Notes/History
KSS AuthenticationService

References

Authentication Service Structures

Principal Entity and Principal Set Entity - 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

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
objectTypeKeyList		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.
objectTypeKey	objectTypeKey	identifier of the object type
objectStructure		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.
enumerationKey	enumerationKey	identifier of the enumeration
enumContextKey	contextType	identifier of the enumeration context type
string	contextValue	value of the enumeration context
dateTime	contextDate	date and time to get the enumeration for
enumeratedValueList		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
searchTypeInfoList		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.
searchTypeKey	searchTypeKey	identifier of the search type
searchTypeInfo		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.
searchResultTypeKey	searchResultTypeKey	identifier of the search result type
searchTypeInfoList		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.
searchCriteriaTypeKey	searchCriteriaTypeKey	identifier of the search criteria
searchTypeInfoList		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
searchResultTypeInfoList		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.
searchResultTypeKey	searchResultTypeKey	identifier of the search result type
searchResultTypeInfo		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
searchCriteriaTypeInfoList		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.
searchCriteriaTypeKey	searchCriteriaTypeKey	identifier of the search criteria type
searchCriteriaTypeInfo		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
authenticationTypeList		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
personId	personId	person identifier
principalIdList		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
systemId	systemId	system identifier
principalIdList		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
principalId	principalId	principal identifier
personId		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
principalId	principalId	principal identifier
systemId		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
principalId	principalId	principal identifier
principalType		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
principalIdList	principalIdList	list of principal identifiers
principalTypeList		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

Search

Method Description Parameters Return Errors Capabilities Use Cases Comments/Feedback

searchForResults
Retrieves results in tabular form for the specified parameters.
searchTypeKey	searchTypeKey	search identifier
queryParamValueList	queryParamValues	list of values for search parameters
resultList		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
principalId	principalId	principal identifier
personId	personId	person identifier
status		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
principalId	principalId	principal identifier
systemId	systemId	system identifier
status		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
principalId	principalId	principal identifier
personId	personId	person identifier
status		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
principalId	principalId	principal identifier
systemId	systemId	system identifier
status		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