|
1 | | -# SAP-samples/repository-template |
2 | | -This default template for SAP Samples repositories includes files for README, LICENSE, and .reuse/dep5. All repositories on github.com/SAP-samples will be created based on this template. |
3 | | - |
4 | | -# Containing Files |
5 | | - |
6 | | -1. The LICENSE file: |
7 | | -In most cases, the license for SAP sample projects is `Apache 2.0`. |
8 | | - |
9 | | -2. The .reuse/dep5 file: |
10 | | -The [Reuse Tool](https://reuse.software/) must be used for your samples project. You can find the .reuse/dep5 in the project initial. Please replace the parts inside the single angle quotation marks < > by the specific information for your repository. |
11 | | - |
12 | | -3. The README.md file (this file): |
13 | | -Please edit this file as it is the primary description file for your project. You can find some placeholder titles for sections below. |
14 | | - |
15 | | -# [Title] |
16 | | -<!-- Please include descriptive title --> |
17 | | - |
18 | 1 | <!--- Register repository https://api.reuse.software/register, then add REUSE badge: |
19 | 2 | [](https://api.reuse.software/info/github.com/SAP-samples/REPO-NAME) |
20 | 3 | --> |
21 | 4 |
|
22 | | -## Description |
23 | | -<!-- Please include SEO-friendly description --> |
| 5 | +# AMS Sample Applications (Node.js) |
| 6 | +The Node.js sample applications in this repository demonstrate [policy based authorization](https://help.sap.com/docs/identity-authentication/identity-authentication/configuring-authorization-policies?locale=en-US) with the Authorization Management Service (AMS) in applications that authenticate users via the [SAP Cloud Identity Services](https://help.sap.com/docs/identity-authentication?locale=en-US) (SCI). The focus of the samples is on the authorization via AMS but as the authentication is a necessary requirement, it is demonstrated as well. |
24 | 7 |
|
25 | | -## Requirements |
| 8 | +- [Node.js CAP sample application](./ams-cap-nodejs-bookshop/) |
| 9 | +- **Node.js express.js sample application**: Coming with `@sap/ams` major release version 3 |
| 10 | + |
| 11 | +## Description |
| 12 | +AMS is the component of SCI that can be enabled to implement and manage an application's authorization in a flexible policy-based language called Data Control Language (DCL). Besides standard authorization checks, it enables applications to provide instance-based authorization capabilities to customers, e.g. limiting a user's access to a slice of the data based on cross-cutting attributes such as company code or region. |
26 | 13 |
|
27 | | -## Download and Installation |
| 14 | +When deployed, authorization policies are managed in the SCI administration cockpit. When running locally, e.g. during development or testing, policies are edited in the IDE and can be assigned to mocked users as demonstrated by the samples. |
28 | 15 |
|
29 | | -## Known Issues |
30 | | -<!-- You may simply state "No known issues. --> |
| 16 | +## Requirements |
| 17 | +- a Node.js LTS version that is at least [in maintenance](https://nodejs.org/en/about/previous-releases) |
| 18 | +- a JDK 17+ for local DCL compilation before unit tests |
31 | 19 |
|
32 | 20 | ## How to obtain support |
33 | | -[Create an issue](https://github.com/SAP-samples/<repository-name>/issues) in this repository if you find a bug or have questions about the content. |
34 | | - |
35 | | -For additional support, [ask a question in SAP Community](https://answers.sap.com/questions/ask.html). |
| 21 | +For bugs and issues of the sample applications themselves or questions about the content, please [create an issue](https://github.com/SAP-samples/ams-samples-node/issues) in this repository. |
36 | 22 |
|
| 23 | +For formal feature requests, bug reports, security issues and support of the client libraries, please use the support channels mentioned in the `README.md` that comes with [@sap/ams](https://www.npmjs.com/package/@sap/ams) and [@sap/ams-dev](https://www.npmjs.com/package/@sap/ams-dev). |
| 24 | + |
37 | 25 | ## Contributing |
38 | | -If you wish to contribute code, offer fixes or improvements, please send a pull request. Due to legal reasons, contributors will be asked to accept a DCO when they create the first pull request to this project. This happens in an automated fashion during the submission process. SAP uses [the standard DCO text of the Linux Foundation](https://developercertificate.org/). |
| 26 | +If you wish to contribute code for the samples, offer fixes or improvements, please send a pull request. Due to legal reasons, contributors will be asked to accept a DCO when they create the first pull request to this project. This happens in an automated fashion during the submission process. SAP uses [the standard DCO text of the Linux Foundation](https://developercertificate.org/). |
39 | 27 |
|
40 | 28 | ## License |
41 | | -Copyright (c) 2024 SAP SE or an SAP affiliate company. All rights reserved. This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the [LICENSE](LICENSE) file. |
| 29 | +Copyright (c) 2025 SAP SE or an SAP affiliate company. All rights reserved. This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the [LICENSE](LICENSE) file. |
0 commit comments