Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Wiki Markup
{div:style=font-weight:bold;font-size:1.2em;}[Authentication Service Home]{div}

...

Panel
borderColor#cccccc
bgColor#ffffff
titleBGColor#eeeeee
borderStylesolid
titleSetupborderStylesolid

Dictionary Operations
#findObjectTypes
#fetchObjectStructure
#fetchEnumeration

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

Domain Operations
#findAuthenticationTypes

Panel
borderColor#cccccc
bgColor#ffffff
titleBGColor#eeeeee
borderStylesolid
titleReadborderStylesolid

(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)

Panel
borderColor#cccccc
bgColor#ffffff
titleBGColor#eeeeee
borderStylesolid
titleSearchborderStylesolid

#searchForResults

Panel
borderColor#cccccc
bgColor#ffffff
titleBGColor#eeeeee
borderStylesolid
titleMaintenanceborderStylesolid

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

Include Page
ServiceOperationStart
ServiceOperationStart

Setup

Anchor
findObjectTypes
findObjectTypes

...

Wiki Markup
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}findAuthenticationTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieve the list of authentication types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[authenticationTypeList|authenticationTypeList Structure]
{td}
{td:class=methodReturnDesc}list of authentication types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}

Back to Operations

Read

Anchor
findPrincipalIdsByPerson
findPrincipalIdsByPerson

...

Wiki Markup
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}findPrincipalTypesByPrincipalIdList
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves a list of Principal Types for a given list of Principal Ids
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}[principalIdList|principalIdList Structure]
{td}
{td:class=methodParamName}principalIdList
{td}
{td:class=methodParamDesc}list of principal identifiers
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[principalTypeList|principalTypeList Structure]
{td}
{td:class=methodReturnDesc}List of principal types that match the supplied criteria
{td}
{tr}
{tr}
{th:class=h|rowspan=6}Errors
{th}
{td:class=methodErrorType|colspan=2}DISABLED_IDENTIFIER
{td}
{td:class=methodErrorDesc}One or more principalIds found but have been retired
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}DOES_NOT_EXIST
{td}
{td:class=methodErrorDesc}One or more principalIds not found
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}INVALID_PARAMETER
{td}
{td:class=methodErrorDesc}invalid principalIdList
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}MISSING_PARAMETER
{td}
{td:class=methodErrorDesc}missing principalId
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}PERMISSION_DENIED
{td}
{td:class=methodErrorDesc}authorization failure
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}

Back to Operations

Anchor
searchForResults
searchForResults

Wiki Markup
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}searchForResults
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves results in tabular form for the specified parameters.
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Parameters
{th}
{td:class=methodParamType}[searchTypeKey|searchTypeKey Structure]
{td}
{td:class=methodParamName}searchTypeKey
{td}
{td:class=methodParamDesc}search identifier
{td}
{tr}
{tr}
{td:class=methodParamType}[queryParamValueList|queryParamValueList Structure]
{td}
{td:class=methodParamName}queryParamValues
{td}
{td:class=methodParamDesc}list of values for search parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[resultList|resultList Structure]
{td}
{td:class=methodReturnDesc}list of results from the query
{td}
{tr}
{tr}
{th:class=h|rowspan=5}Errors
{th}
{td:class=methodErrorType|colspan=2}DOES_NOT_EXIST
{td}
{td:class=methodErrorDesc}specified search type not found
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}INVALID_PARAMETER
{td}
{td:class=methodErrorDesc}invalid searchTypeKey, queryParamValueList
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}MISSING_PARAMETER
{td}
{td:class=methodErrorDesc}searchTypeKey, queryParamValueList not specified
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}PERMISSION_DENIED
{td}
{td:class=methodErrorDesc}authorization failure
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}

Back to Operations

Maintenance

Anchor
assignPrincipalToPerson
assignPrincipalToPerson

...