|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AccountLinkingService
Defines the methods needed by PingFederate to store, retrieve, and terminate account links.
Note that this interface is utilized only when operating PingFederate as an SP and when one or more IdP connection are configured to use account linking as the means to identify the local identifier of the subject.
Method Summary | |
---|---|
java.lang.String |
lookupLink(java.lang.String idpEntityId,
java.lang.String authnAdapterId,
java.lang.String externalIdentifier)
Lookup a local user id keyed from he composite key of idpEntityId, authnaAdapterId, and externalIdentifier. |
void |
storeLink(java.lang.String localIdentifier,
java.lang.String idpEntityId,
java.lang.String authnAdapterId,
java.lang.String externalIdentifier)
Store the account link - an association of the composite key of idpEntityId, authnaAdapterId, and externalIdentifier to the localIdentifier. |
void |
terminateLink(java.lang.String idpEntityId,
java.lang.String authnAdapterId,
java.lang.String externalIdentifier)
Terminate the account link identified by the he composite key of idpEntityId, authnaAdapterId, and externalIdentifier. |
Method Detail |
---|
java.lang.String lookupLink(java.lang.String idpEntityId, java.lang.String authnAdapterId, java.lang.String externalIdentifier) throws AccountLinkingServiceException
idpEntityId
- the entity id of the IdP partner connection that issued the external identifier.authnAdapterId
- the id of the SpAuthenticationAdapter instance.externalIdentifier
- the external identifier sent by the IdP.
AccountLinkingServiceException
- for any unexpected runtime problem that the implementation cannot handle.void storeLink(java.lang.String localIdentifier, java.lang.String idpEntityId, java.lang.String authnAdapterId, java.lang.String externalIdentifier) throws AccountLinkingServiceException
localIdentifier
- the the local user id of the principal.idpEntityId
- the entity id of the IdP partner connection that issued the external identifier.authnAdapterId
- the id of the SpAuthenticationAdapter instance.externalIdentifier
- the external identifier sent by the IdP.
AccountLinkingServiceException
- for any unexpected runtime problem that the implementation cannot handle.void terminateLink(java.lang.String idpEntityId, java.lang.String authnAdapterId, java.lang.String externalIdentifier) throws AccountLinkingServiceException
idpEntityId
- the entity id of the IdP partner connection that issued the external identifier.authnAdapterId
- the id of the SpAuthenticationAdapter instance.externalIdentifier
- the external identifier sent by the IdP.
AccountLinkingServiceException
- for any unexpected runtime problem that the implementation cannot handle.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |