user-api-service-b80abb0.md

User API Service

The application router exposes a user API that returns the details of the users who are logged in to the application.

You implement the user API by modelling an xs-app.json route.

The user API supports two endpoints:

• /currentUser returns all details of logged in users.

• /attributes returns the main user properties.

The /currentUser endpoint response has the following format:

Sample Code:

{ "firstname": "John", "lastname": "Doe", "email": "[email protected]", "name": "[email protected]", "displayName": "John Doe ([email protected])" (The user ID in the identity provider), "scopes": ["openid","user_attributes","uaa.user"] (Only if the authentication type is “xsuaa") }

The /attributes endpoint response has the following format:

Sample Code:

{ "firstname": "John", "lastname": "Doe", "email": "[email protected]", "name": "[email protected]" (The user ID in the identity provider), "scopes": ["openid","user_attributes","uaa.user"] (Only if the authentication type is “xsuaa"), < user attributes including custom attributes > (Only if the authentication type is “xsuaa") }

Note:

The "name" property is the user ID in the identity provider, which in many cases is also the email address.

Note:

If you specify “xsuaa” as the authentication type for the route, the following applies:

• User scopes from the xsuaa access token are added to the response of both endpoints (/currentUser and /attributes ).

• User attributes from the identity provider (IdP) chosen for the authentication are added to the response of the /attributes endpoint. If a custom IdP is configured for SAP Cloud Identity Services – Identity Authentication, the custom user attributes are also added to the response of the /attributes endpoint. For more information about the definition of user attributes in Identity Authentication, see .User Attributes .

• To get the user attributes from the custom IdP, add the following property to xs-security.json file of the application router: "foreign-scope-references": ["user_attributes"]

Configuring the User API Service in the Routing Configuration File

You implement the user API by modelling an xs-app.json route using the sap-approuter-userapi service .

The following example handles both endpoints:

Sample Code:

{
    "source": "^/user-api(.*)",
    "target": "$1",
    "service": "sap-approuter-userapi"
}

The following example uses only the /currentUser endpoint:

Sample Code:

{
    "source": "^/user-api/currentUser$",
    "target": "/currentUser",
    "service": "sap-approuter-userapi"
}

Related Information

routes