Page Comparison

Div

style	font-weight:bold;font-size:1.2em;

Authentication Service Home

Kuali Authentication Service

Include Page

	SDRcollectionspace:Service Meta Table Style PageSDR
	collectionspace:Service Meta Table Style Page

HTML Table

id	serviceMetaTable

Table Row (tr)

Table Head (th)

class	h

Name

Table Cell (td)

colspan	2
id	serviceName

AuthenticationService

Table Row (tr)

Table Head (th)

class	h

Version

Table Cell (td)

id	serviceVersion

Dev

Table Cell (td)

id	serviceVersionHistory

Release Notes/History

Table Row (tr)

Table Head (th)

class	h

Based upon

Table Cell (td)

colspan	2
id	serviceName

KSS AuthenticationService

#References

#Operations

#Capabilities

Note

title	Notes

References

Authentication Service Structures

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

Include Page

	SDRcollectionspace:Method Table Style PageSDR
	collectionspace:Method Table Style Page

Panel

borderColor	#cccccc
bgColor	#ffffff
titleBGColor	#eeeeee
borderStyle	solid
title	Setup	borderStyle	solid

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
borderStyle	solid
title	Read	borderStyle	solid

Need to add operation for fetchCurrentUser

#fetchPrincipal
#findPrincipalsByIdList

#fetchPrincipalDisplayInfo
#findPrincipalDisplayInfoByIdList

#findPrincipalIdsByPerson
#findPrincipalIdsBySystem

#fetchPersonIdByPrincipal
#fetchSystemIdByPrincipal Changed Service to System
#fetchPrincipalTypeForPrincipal

#findPrincipalTypesByPrincipalIdList

Panel

borderColor	#cccccc
bgColor	#ffffff
titleBGColor	#eeeeee
borderStyle	solid
title	Search	borderStyle	solid

#searchForResults

Panel

borderColor	#cccccc
bgColor	#ffffff
titleBGColor	#eeeeee
borderStyle	solid
title	Maintenance	borderStyle	solid

#assignPrincipalToPerson
#assignPrincipalToSystem Changed Service to System
#removePrincipalFromPerson
#removePrincipalFromSystem Changed Service to System

Include Page

	SDR:ServiceOperationStartSDR:
	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

findObjectTypes

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves the list of object type identifiers known by this service. Example: cluInfo.

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

objectTypeKeyList

Table Cell (td)

colspan	2
class	methodReturnType

	methodReturnType

/wiki/spaces/collectionspace/pages/666274931

Table Cell (td)

class	methodReturnDesc

list of object type identifiers

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

fetchObjectStructure

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

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.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

objectTypeKey /wiki/spaces/collectionspace/pages/666274955

Table Cell (td)

class	methodParamName

objectTypeKey

Table Cell (td)

class	methodParamDesc

identifier of the object type

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

objectStructure /wiki/spaces/collectionspace/pages/666274927

Table Cell (td)

class	methodReturnDesc

describes the fields for the input object type

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

specified objectTypeKey not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid objectTypeKey

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing objectTypeKey

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

fetchEnumeration

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

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.

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Parameters

Table Cell (td)

class	methodParamType

enumerationKey /wiki/spaces/collectionspace/pages/666274894

Table Cell (td)

class	methodParamName

enumerationKey

Table Cell (td)

class	methodParamDesc

identifier of the enumeration

Table Row (tr)

Table Cell (td)

class	methodParamType

enumContextKey /wiki/spaces/collectionspace/pages/666274903

Table Cell (td)

class	methodParamName

contextType

Table Cell (td)

class	methodParamDesc

identifier of the enumeration context type

Table Row (tr)

Table Cell (td)

class	methodParamType

string /wiki/spaces/collectionspace/pages/666274808

Table Cell (td)

class	methodParamName

contextValue

Table Cell (td)

class	methodParamDesc

value of the enumeration context

Table Row (tr)

Table Cell (td)

class	methodParamType

dateTime /wiki/spaces/collectionspace/pages/666274812

Table Cell (td)

class	methodParamName

contextDate

Table Cell (td)

class	methodParamDesc

date and time to get the enumeration for

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

enumeratedValueList /wiki/spaces/collectionspace/pages/666274883

Table Cell (td)

class	methodReturnDesc

list of enumerated codes and values

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

enumerationKey not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid enumerationKey, contextType, contextValue, contextDate

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing enumerationKey, contextType, contextValue, contextDate

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

findSearchTypes

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves the list of search 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

searchTypeInfoList

Table Cell (td)

colspan	2
class	methodReturnType

	methodReturnType

/wiki/spaces/collectionspace/pages/666274914

Table Cell (td)

class	methodReturnDesc

list of search type information

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

fetchSearchType

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves information about a particular search type.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

searchTypeKey /wiki/spaces/collectionspace/pages/666275028

Table Cell (td)

class	methodParamName

searchTypeKey

Table Cell (td)

class	methodParamDesc

identifier of the search type

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

searchTypeInfo /wiki/spaces/collectionspace/pages/666274920

Table Cell (td)

class	methodReturnDesc

information on the search type

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

specified searchTypeKey not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid searchTypeKey

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

searchTypeKey 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 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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

findSearchTypesByResult

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves the list of search types which return results in the specified format.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

searchResultTypeKey /wiki/spaces/collectionspace/pages/666275032

Table Cell (td)

class	methodParamName

searchResultTypeKey

Table Cell (td)

class	methodParamDesc

identifier of the search result type

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

searchTypeInfoList /wiki/spaces/collectionspace/pages/666274914

Table Cell (td)

class	methodReturnDesc

list of search type information

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

specified searchResultTypeKey not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid searchResultTypeKey

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

searchResultTypeKey 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 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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

findSearchTypesByCriteria

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves the list of search types which use criteria in the specified format.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

searchCriteriaTypeKey /wiki/spaces/collectionspace/pages/666275018

Table Cell (td)

class	methodParamName

searchCriteriaTypeKey

Table Cell (td)

class	methodParamDesc

identifier of the search criteria

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

searchTypeInfoList /wiki/spaces/collectionspace/pages/666274914

Table Cell (td)

class	methodReturnDesc

list of search type information

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

specified searchCriteriaTypeKey not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid searchCriteriaTypeKey

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

searchCriteriaTypeKey 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 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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

findSearchResultTypes

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves the list of search result types known by this service. Search result types describe the return structure for a search.

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

searchResultTypeInfoList /wiki/spaces/collectionspace/pages/666275023

Table Cell (td)

class	methodReturnDesc

list of search result type information

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

fetchSearchResultType

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves information about a particular search result type. Search result types describe the return structure for a search.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

searchResultTypeKey

Table Cell (td)

class	methodParamType

	methodParamType

/wiki/spaces/collectionspace/pages/666275032

Table Cell (td)

class	methodParamName

searchResultTypeKey

Table Cell (td)

class	methodParamDesc

identifier of the search result type

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

searchResultTypeInfo /wiki/spaces/collectionspace/pages/666274906

Table Cell (td)

class	methodReturnDesc

information on the search result type

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

specified searchResultTypeKey not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid searchResultTypeKey

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

searchResultTypeKey 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 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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

findSearchCriteriaTypes

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves the list of search criteria 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

searchCriteriaTypeInfoList /wiki/spaces/collectionspace/pages/666274979

Table Cell (td)

class	methodReturnDesc

list of search criteria type information

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

fetchSearchCriteriaType

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves information about a particular search criteria type.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

searchCriteriaTypeKey /wiki/spaces/collectionspace/pages/666275018

Table Cell (td)

class	methodParamName

searchCriteriaTypeKey

Table Cell (td)

class	methodParamDesc

identifier of the search criteria type

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

searchCriteriaTypeInfo /wiki/spaces/collectionspace/pages/666274965

Table Cell (td)

class	methodReturnDesc

information on the search criteria type

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

specified searchCriteriaTypeKey not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid searchCriteriaTypeKey

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

searchCriteriaTypeKey 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 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

...

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 /wiki/spaces/collectionspace/pages/666274728

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

findPrincipalIdsByPerson

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves a list of Principals for a given Person

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

personId /wiki/spaces/collectionspace/pages/666275074

Table Cell (td)

class	methodParamName

personId

Table Cell (td)

class	methodParamDesc

person identifier

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

principalIdList /wiki/spaces/collectionspace/pages/666274736

Table Cell (td)

class	methodReturnDesc

list of principal ids for the specified person

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

personId found but has been retired

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

personId not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid personId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing personId

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

findPrincipalIdsBySystem

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves a list of Principals for a given System

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

systemId

Table Cell (td)

class	methodParamType

	methodParamType

/wiki/spaces/collectionspace/pages/666274703

Table Cell (td)

class	methodParamName

systemId

Table Cell (td)

class	methodParamDesc

system identifier

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

principalIdList /wiki/spaces/collectionspace/pages/666274736

Table Cell (td)

class	methodReturnDesc

list of principal ids for the given system

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

systemId found but has been retired

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

systemId not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid systemId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing systemId

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

fetchPersonIdByPrincipal

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves a Person for a given Principal

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

principalId /wiki/spaces/collectionspace/pages/666274739

Table Cell (td)

class	methodParamName

principalId

Table Cell (td)

class	methodParamDesc

principal identifier

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

personId /wiki/spaces/collectionspace/pages/666275074

Table Cell (td)

class	methodReturnDesc

person identifier that matches 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

principalId found but has been retired

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

principalId not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid principalId

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

fetchSystemByPrincipal

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves a System for a given Principal

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

principalId /wiki/spaces/collectionspace/pages/666274739

Table Cell (td)

class	methodParamName

principalId

Table Cell (td)

class	methodParamDesc

principal identifier

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

systemId /wiki/spaces/collectionspace/pages/666274703

Table Cell (td)

class	methodReturnDesc

system identifier that matches 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

systemId found but has been retired

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

systemId not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid principalId

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

fetchPrincipalTypeForPrincipal

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves a Principal Type for a given Principal

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

principalId /wiki/spaces/collectionspace/pages/666274739

Table Cell (td)

class	methodParamName

principalId

Table Cell (td)

class	methodParamDesc

principal identifier

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

principalType /wiki/spaces/collectionspace/pages/666274690

Table Cell (td)

class	methodReturnDesc

principal type that matches 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

principalId found but has been retired

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

principalId not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid principalId

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

...

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

principalIdList

Table Cell (td)

class	methodParamType

	methodParamType

/wiki/spaces/collectionspace/pages/666274736

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 /wiki/spaces/collectionspace/pages/666274684

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 /wiki/spaces/collectionspace/pages/666275028

Table Cell (td)

class	methodParamName

searchTypeKey

Table Cell (td)

class	methodParamDesc

search identifier

Table Row (tr)

Table Cell (td)

class	methodParamType

queryParamValueList /wiki/spaces/collectionspace/pages/666275094

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 /wiki/spaces/collectionspace/pages/666275096

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

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

assignPrincipalToPerson

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Assigns a Principal to a Person

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

principalId /wiki/spaces/collectionspace/pages/666274739

Table Cell (td)

class	methodParamName

principalId

Table Cell (td)

class	methodParamDesc

principal identifier

Table Row (tr)

Table Cell (td)

class	methodParamType

personId /wiki/spaces/collectionspace/pages/666275074

Table Cell (td)

class	methodParamName

personId

Table Cell (td)

class	methodParamDesc

person identifier

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

status /wiki/spaces/collectionspace/pages/666275040

Table Cell (td)

class	methodReturnDesc

status of the operation

Table Row (tr)

Table Head (th)

rowspan	7
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

ALREADY_EXISTS

Table Cell (td)

class	methodErrorDesc

association already exists

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DISABLED_IDENTIFIER

Table Cell (td)

class	methodErrorDesc

personId or principalId found but has been retired

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

personId, principalId does not exist

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid personId, principalId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing personId, 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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

assignPrincipalToSystem

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Assigns a Principal to a System

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

principalId /wiki/spaces/collectionspace/pages/666274739

Table Cell (td)

class	methodParamName

principalId

Table Cell (td)

class	methodParamDesc

principal identifier

Table Row (tr)

Table Cell (td)

class	methodParamType

systemId /wiki/spaces/collectionspace/pages/666274703

Table Cell (td)

class	methodParamName

systemId

Table Cell (td)

class	methodParamDesc

system identifier

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

status /wiki/spaces/collectionspace/pages/666275040

Table Cell (td)

class	methodReturnDesc

status of the operation

Table Row (tr)

Table Head (th)

rowspan	7
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

ALREADY_EXISTS

Table Cell (td)

class	methodErrorDesc

association already exists

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DISABLED_IDENTIFIER

Table Cell (td)

class	methodErrorDesc

principalId, systemId found but has been retired

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

principalId, systemId does not exist

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid principalId, systemId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing principalId, systemId

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

removePrincipalFromPerson

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Remove a Principal from a Person

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

principalId /wiki/spaces/collectionspace/pages/666274739

Table Cell (td)

class	methodParamName

principalId

Table Cell (td)

class	methodParamDesc

principal identifier

Table Row (tr)

Table Cell (td)

class	methodParamType

personId /wiki/spaces/collectionspace/pages/666275074

Table Cell (td)

class	methodParamName

personId

Table Cell (td)

class	methodParamDesc

person identifier

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

status /wiki/spaces/collectionspace/pages/666275040

Table Cell (td)

class	methodReturnDesc

status of the operation

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

personId or principalId found but has been retired

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

personId, principalId, association does not exist

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid personId, principalId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing personId, 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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

removePrincipalFromSystem

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Remove a Principal from a System

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

principalId /wiki/spaces/collectionspace/pages/666274739

Table Cell (td)

class	methodParamName

principalId

Table Cell (td)

class	methodParamDesc

principal identifier

Table Row (tr)

Table Cell (td)

class	methodParamType

systemId /wiki/spaces/collectionspace/pages/666274703

Table Cell (td)

class	methodParamName

systemId

Table Cell (td)

class	methodParamDesc

system identifier

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

status /wiki/spaces/collectionspace/pages/666275040

Table Cell (td)

class	methodReturnDesc

status of the operation

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

principalId, systemId found but has been retired

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

principalId, systemId, association does not exist

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid principalId, systemId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing principalId, systemId

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

Include Page

	SDR:ServiceOperationStopSDR:
	ServiceOperationStop

Versions Compared

Old Version 13

New Version Current

Key

Kuali Authentication Service

References

Operations

Setup

Read

Search

Maintenance

Capabilities