From ea4ef74917a9525b1da4d9ddd2cf472c4e4fbcf4 Mon Sep 17 00:00:00 2001 From: Awambeng <114798938+Awambeng@users.noreply.github.com> Date: Tue, 13 May 2025 09:09:14 +0100 Subject: [PATCH] Fix doc(oid4vc): Correct realm-attributes example and update HTTP method in docs (#39409) Closes #39264 Signed-off-by: Awambeng Rodrick --- .../topics/oid4vci/vc-issuer-configuration.adoc | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/documentation/server_admin/topics/oid4vci/vc-issuer-configuration.adoc b/docs/documentation/server_admin/topics/oid4vci/vc-issuer-configuration.adoc index b5852320f7c..3a580ae0c63 100644 --- a/docs/documentation/server_admin/topics/oid4vci/vc-issuer-configuration.adoc +++ b/docs/documentation/server_admin/topics/oid4vci/vc-issuer-configuration.adoc @@ -130,9 +130,9 @@ Create a JSON file (e.g., `realm-attributes.json`) with the following content: { "realm": "oid4vc-vci", "enabled": true, - "preAuthorizedCodeLifespanS": 120, - "issuerDid": "https://localhost:8443/realms/oid4vc-vci", "attributes": { + "preAuthorizedCodeLifespanS": 120, + "issuerDid": "https://localhost:8443/realms/oid4vc-vci", "vc.IdentityCredential.expiry_in_s": "31536000", "vc.IdentityCredential.format": "vc+sd-jwt", "vc.IdentityCredential.scope": "identity_credential", @@ -156,9 +156,9 @@ This is a **sample configuration**. You can define **additional attributes** dep ==== Attribute Breakdown +The attributes section contains issuer-specific and credential-specific metadata: - **preAuthorizedCodeLifespanS** – Defines how long pre-authorized codes remain valid (in seconds). - **issuerDid** – The Decentralized Identifier (DID) of the issuer. -- **attributes** – Contains VC-specific metadata, which can be **expanded** as needed: - **expiry_in_s** – Credential expiration time (in seconds). - **format** – Defines the VC format (e.g., `vc+sd-jwt`). - **scope** – Identifies the credential’s scope. @@ -171,7 +171,7 @@ Use the following `curl` command to import the attributes into {project_name}: [source,bash] ---- -curl -X POST "https://localhost:8443/admin/realms/oid4vc-vci" \ +curl -X PUT "https://localhost:8443/admin/realms/oid4vc-vci" \ -H "Authorization: Bearer $ACCESS_TOKEN" \ -H "Content-Type: application/json" \ -d @realm-attributes.json @@ -181,7 +181,6 @@ curl -X POST "https://localhost:8443/admin/realms/oid4vc-vci" \ ==== - Replace `$ACCESS_TOKEN` with a valid **{project_name} Admin API access token**. - **Avoid using `-k` in production**; instead, configure a **trusted TLS certificate**. -- If updating an existing realm, use `PUT` instead of `POST`. ==== === Create Client Scopes with Mappers