Page Comparison

Authentication Service

Include Page

	SDR:Service Meta Table Style Page
	SDR:Service Meta Table Style Page

...

Insert excerpt

	SDR:Authentication Service Description and Assumptions
	SDR:Authentication Service Description and Assumptions

Note

title	Notes

References

Authentication Service Description and Assumptions
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

Include Page

	SDR:Method Table Style Page
	SDR:Method Table Style Page

...

Include Page

	SDR:ServiceOperationStart
	SDR:ServiceOperationStart

Setup

Anchor

	findObjectTypes
	findObjectTypes

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

findAuthenticationTypes

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieve the list of authentication types known by this service

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

None

Table Cell (td)

class	methodParamName

None

Table Cell (td)

class	methodParamDesc

No parameters

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

authenticationTypeList

Table Cell (td)

class	methodReturnDesc

list of authentication types

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

OPERATION_FAILED

Table Cell (td)

class	methodErrorDesc

unable to complete request

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Read

Anchor

	findPrincipalIdsByPerson
	findPrincipalIdsByPerson

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

findPrincipalTypesByPrincipalIdList

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves a list of Principal Types for a given list of Principal Ids

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

principalIdList

Table Cell (td)

class	methodParamName

principalIdList

Table Cell (td)

class	methodParamDesc

list of principal identifiers

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

principalTypeList

Table Cell (td)

class	methodReturnDesc

List of principal types that match the supplied criteria

Table Row (tr)

Table Head (th)

rowspan	6
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DISABLED_IDENTIFIER

Table Cell (td)

class	methodErrorDesc

One or more principalIds found but have been retired

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

One or more principalIds not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid principalIdList

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing principalId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

OPERATION_FAILED

Table Cell (td)

class	methodErrorDesc

unable to complete request

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

PERMISSION_DENIED

Table Cell (td)

class	methodErrorDesc

authorization failure

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Search

Anchor

	searchForResults
	searchForResults

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

searchForResults

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves results in tabular form for the specified parameters.

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

searchTypeKey

Table Cell (td)

class	methodParamName

searchTypeKey

Table Cell (td)

class	methodParamDesc

search identifier

Table Row (tr)

Table Cell (td)

class	methodParamType

queryParamValueList

Table Cell (td)

class	methodParamName

queryParamValues

Table Cell (td)

class	methodParamDesc

list of values for search parameters

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

resultList

Table Cell (td)

class	methodReturnDesc

list of results from the query

Table Row (tr)

Table Head (th)

rowspan	5
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

specified search type not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid searchTypeKey, queryParamValueList

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

searchTypeKey, queryParamValueList not specified

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

OPERATION_FAILED

Table Cell (td)

class	methodErrorDesc

unable to complete request

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

PERMISSION_DENIED

Table Cell (td)

class	methodErrorDesc

authorization failure

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Maintenance

Anchor

	assignPrincipalToPerson
	assignPrincipalToPerson

...

Include Page

	SDR:ServiceOperationStop
	SDR:ServiceOperationStop

Versions Compared

Old Version 6

New Version 7

Key

Authentication Service

References

Operations

Setup

Read

Search

Maintenance

Capabilities