From f49d066ac7cdc19d819575002c01b97963601fbd Mon Sep 17 00:00:00 2001 From: Paul Latzelsperger Date: Fri, 5 Jul 2024 07:59:01 +0200 Subject: [PATCH] move scopes into root object --- .../README.md | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/docs/developer/decision-records/2024-07-03-additional-catalogrequest-param/README.md b/docs/developer/decision-records/2024-07-03-additional-catalogrequest-param/README.md index 16554598d3f..33e16f3ed09 100644 --- a/docs/developer/decision-records/2024-07-03-additional-catalogrequest-param/README.md +++ b/docs/developer/decision-records/2024-07-03-additional-catalogrequest-param/README.md @@ -16,15 +16,14 @@ these are static - they can't be changed at runtime. So if a provider offers assets, that are only available is a special (non-default) credential is presented, the consumer must be able to attach the respective scope strings to the access token. -_NB: the information \_which_ scopes must be added, has to be conveyed out-of-band.\_ +_NB: the information which scopes must be added, has to be conveyed out-of-band._ In other words, a consumer may know that a provider has certain assets available, but they have an access policy constraint on them, which makes them "invisible" unless a certain credential is presented. ## Approach -The `CatalogRequest` will receive a new field `parameters`, which is an extensible map. This map may contain an -entry `additionalScopes` which is a list of scope strings (as +The `CatalogRequest` will receive a new nullable field `additionalScopes` which is a list of scope strings (as per [DCP Specification, Section 3.1](https://github.com/eclipse-tractusx/identity-trust/blob/main/specifications/verifiable.presentation.protocol.md#31-access-scopes)): ```json @@ -36,18 +35,16 @@ per [DCP Specification, Section 3.1](https://github.com/eclipse-tractusx/identit "querySpec": { //... }, - "parameters": { - "additionalScopes": [ - "org.eclipse.edc.vc.type.AdditionalCredentialType1:read", - "org.eclipse.edc.vc.type.AdditionalCredentialType2:*" - ] - } + "additionalScopes": [ + "org.eclipse.edc.vc.type.AdditionalCredentialType1:read", + "org.eclipse.edc.vc.type.AdditionalCredentialType2:*" + ] } ``` Scope strings provided in that fashion will get added to the default scopes. -NB: both the `parameters` map and the `additionalScopes` entry are _OPTIONAL_. +NB: the `additionalScopes` entry is _OPTIONAL_. This feature will be added in an Alpha version of the Management API first, specifically of `3.1.0-alpha`. The respective URL path will be `/v3.1alpha/api/management/catalog/request` as per