com.sap.xsa.security.container

Interface XSUserInfo

public interface XSUserInfo

API for OAuth resource servers to extract authentication and authorization information from the OAuth token.

Method Summary

Modifier and Type	Method and Description
boolean	checkLocalScope(String scope) Check if a local scope is available in the authentication token
boolean	checkScope(String scope) Check if a scope is present in the authentication token
String	getAdditionalAuthAttribute(String attributeName) Return additional authentication attributes included by the OAuth client component.
String	getAppToken() Return authentication token
String[]	getAttribute(String attributeName) Return user attributes
String	getClientId() Return the client id of the authentication token
String	getCloneServiceInstanceId() In case of xsuaa broker plan tokens, it contains the service instance id
String	getDBToken() Deprecated.
String	getEmail() Return the email of the user
String	getFamilyName() Familiy name of the user.
String	getGivenName() Given name of the user.
String	getGrantType() OAuth Grant Type used for this token
String	getHdbToken()
String	getIdentityZone() Return identity zone
String	getJsonValue(String attribute) Deprecated.
String	getLogonName() User name used for authentication, e.g.
String	getOrigin() Return the user origin.
String	getSubaccountId() Return subaccount identifier
String	getSubdomain() Return the subdomain of this subaccount
String[]	getSystemAttribute(String attributeName) Deprecated.
String	getToken(String namespace, String name) Deprecated.
boolean	hasAttributes() Check if the authentication token contains user attributes
boolean	isInForeignMode() Check if a token issued for another OAuth client has been forwarded to a different client,
String	requestToken(XSTokenRequest tokenRequest) Exchange a token into a token from another service instance
String	requestTokenForClient(String clientId, String clientSecret, String uaaUrl) Deprecated.

Method Detail

getLogonName

String getLogonName()
             throws XSUserInfoException

User name used for authentication, e.g. an email address or other identifier. A user might exist in multiple identity providers. The following information is required to to uniquely identify a user: - - - username: name of the user in an identity provider - origin: alias to an identity provider - subaccount id: identifier for the subaccount

Returns:

user name

Throws:

XSUserInfoException - if attribute is not available in the authentication token

getGivenName

String getGivenName()
             throws XSUserInfoException

Given name of the user.

Returns:

given name

Throws:

XSUserInfoException - if attribute is not available in the authentication token

getFamilyName

String getFamilyName()
              throws XSUserInfoException

Familiy name of the user.

Returns:

family name

Throws:

XSUserInfoException - if attribute is not available in the authentication token

getOrigin

String getOrigin()
          throws XSUserInfoException

Return the user origin. The origin is an alias that refers to a user store in which the user is persisted. For example, users that are authenticated by the UAA itself with a username/password combination have their origin set to the value uaa.

Returns:

user origin

Throws:

XSUserInfoException - if attribute is not available in the authentication token

getIdentityZone

String getIdentityZone()
                throws XSUserInfoException

Return identity zone

Returns:

identity zone

Throws:

XSUserInfoException - if attribute is not available in the authentication token

getSubaccountId

String getSubaccountId()
                throws XSUserInfoException

Return subaccount identifier

Returns:

subaccount identifier

Throws:

XSUserInfoException - if attribute is not available in the authentication token

getSubdomain

String getSubdomain()
             throws XSUserInfoException

Return the subdomain of this subaccount

Returns:

subdomain

Throws:

XSUserInfoException - if attribute is not available in the authentication token

getClientId

String getClientId()
            throws XSUserInfoException

Return the client id of the authentication token

Returns:

client id

Throws:

XSUserInfoException - if attribute is not available in the authentication token

getJsonValue

@Deprecated
String getJsonValue(String attribute)
                         throws XSUserInfoException

Deprecated.

Throws:

XSUserInfoException

getEmail

String getEmail()
         throws XSUserInfoException

Return the email of the user

Returns:

email

Throws:

XSUserInfoException - if attribute is not available in the authentication token

getDBToken

@Deprecated
String getDBToken()
                       throws XSUserInfoException

Deprecated.

Throws:

XSUserInfoException

getHdbToken

String getHdbToken()
            throws XSUserInfoException

Throws:

XSUserInfoException

getAppToken

String getAppToken()

Return authentication token

Returns:

authentication token

getToken

@Deprecated
String getToken(String namespace,
                            String name)
                     throws XSUserInfoException

Deprecated.

Throws:

XSUserInfoException

getAttribute

String[] getAttribute(String attributeName)
               throws XSUserInfoException

Return user attributes

Parameters:

attributeName - name of attribute

Returns:

attribute values array

Throws:

XSUserInfoException - if attribute is not available in the authentication token

hasAttributes

boolean hasAttributes()
               throws XSUserInfoException

Check if the authentication token contains user attributes

Returns:

true if user attributes are available

Throws:

XSUserInfoException - if attribute is not available in the authentication token

getSystemAttribute

@Deprecated
String[] getSystemAttribute(String attributeName)
                                 throws XSUserInfoException

Deprecated.

Throws:

XSUserInfoException

checkScope

boolean checkScope(String scope)
            throws XSUserInfoException

Check if a scope is present in the authentication token

Parameters:

scope - name of fully qualified scope

Returns:

true if scope is available

Throws:

XSUserInfoException - if attribute is not available in the authentication token

checkLocalScope

boolean checkLocalScope(String scope)
                 throws XSUserInfoException

Check if a local scope is available in the authentication token

Parameters:

scope - name of local scope (ommitting the xsappid)

Returns:

true if local scope (scope without xsappid) is available

Throws:

XSUserInfoException - if attribute is not available in the authentication token

getAdditionalAuthAttribute

String getAdditionalAuthAttribute(String attributeName)
                           throws XSUserInfoException

Return additional authentication attributes included by the OAuth client component. Note: this is data controlled by the requester of a token. Might be not trustworthy.

Parameters:

attributeName - name of the authentication attribute

Returns:

addition authentication attributes

Throws:

XSUserInfoException - if attribute is not available in the authentication token

getCloneServiceInstanceId

String getCloneServiceInstanceId()
                          throws XSUserInfoException

In case of xsuaa broker plan tokens, it contains the service instance id

Returns:

service instance id

Throws:

XSUserInfoException - if attribute is not available in the authentication token

getGrantType

String getGrantType()
             throws XSUserInfoException

OAuth Grant Type used for this token

Returns:

grant type

Throws:

XSUserInfoException - if attribute is not available in the authentication token

isInForeignMode

boolean isInForeignMode()
                 throws XSUserInfoException

Check if a token issued for another OAuth client has been forwarded to a different client,

Returns:

true if token was forwarded

Throws:

XSUserInfoException - if attribute is not available in the authentication token

requestTokenForClient

@Deprecated
String requestTokenForClient(String clientId,
                                         String clientSecret,
                                         String uaaUrl)
                                  throws XSUserInfoException

Deprecated.

Throws:

XSUserInfoException

requestToken

String requestToken(XSTokenRequest tokenRequest)
             throws XSUserInfoException

Exchange a token into a token from another service instance

Parameters:

tokenRequest - request data

Returns:

requested token

Throws:

XSUserInfoException - if attribute is not available in the authentication token