@digdir/dialogporten-schema 1.106.2 → 1.107.0-1eab3ba

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digdir/dialogporten-schema",
-  "version": "1.106.2",
+  "version": "1.107.0-1eab3ba",
   "description": "GraphQl schema and OpenAPI spec for Dialogporten",
   "engines": {
     "node": "24"

package/schema.verified.graphql

@@ -12,6 +12,10 @@ interface DialogByIdError {
   message: String!
 }
 
+interface DialogLookupError {
+  message: String!
+}
+
 interface SearchDialogError {
   message: String!
 }
@@ -169,6 +173,7 @@ type Content {
 type ContentValue {
   value: [Localization!]!
   mediaType: String!
+  isAuthorized: Boolean
 }
 
 type Dialog {
@@ -267,6 +272,59 @@ type DialogEventPayload {
   type: DialogEventType!
 }
 
+type DialogLookup {
+  dialogId: UUID!
+  instanceRef: String!
+  party: String!
+  serviceResource: DialogLookupServiceResource!
+  serviceOwner: DialogLookupServiceOwner!
+  authorizationEvidence: DialogLookupAuthorizationEvidence!
+}
+
+type DialogLookupAuthorizationEvidence {
+  minimumAuthenticationLevel: Int!
+  currentAuthenticationLevel: Int!
+  viaRole: Boolean!
+  viaAccessPackage: Boolean!
+  viaResourceDelegation: Boolean!
+  viaInstanceDelegation: Boolean!
+  evidence: [DialogLookupAuthorizationEvidenceItem!]!
+}
+
+type DialogLookupAuthorizationEvidenceItem {
+  grantType: DialogLookupGrantType!
+  subject: String!
+}
+
+type DialogLookupForbidden implements DialogLookupError {
+  message: String!
+}
+
+type DialogLookupNotFound implements DialogLookupError {
+  message: String!
+}
+
+type DialogLookupPayload {
+  lookup: DialogLookup
+  errors: [DialogLookupError!]!
+}
+
+type DialogLookupServiceOwner {
+  orgNumber: String!
+  code: String!
+  name: [Localization!]!
+}
+
+type DialogLookupServiceResource {
+  id: String!
+  isDelegable: Boolean!
+  name: [Localization!]!
+}
+
+type DialogLookupValidationError implements DialogLookupError {
+  message: String!
+}
+
 type EndUserContext {
   revision: UUID!
   systemLabels: [SystemLabel!]!
@@ -318,6 +376,7 @@ type Mutations {
 }
 
 type Queries @authorize(policy: "enduser") {
+  dialogLookup(instanceRef: String!): DialogLookupPayload!
   dialogById(dialogId: UUID!): DialogByIdPayload!
   searchDialogs(input: SearchDialogInput!): SearchDialogsPayload!
   limits: Limits!
@@ -658,6 +717,13 @@ enum DialogEventType {
   DIALOG_DELETED
 }
 
+enum DialogLookupGrantType {
+  ROLE
+  ACCESS_PACKAGE
+  RESOURCE_DELEGATION
+  INSTANCE_DELEGATION
+}
+
 enum DialogStatus {
   "Started. In a serial process, this is used to indicate that, for example, a form filling is ongoing."
   IN_PROGRESS

package/src/index.js

@@ -12,6 +12,10 @@ interface DialogByIdError {
   message: String!
 }
 
+interface DialogLookupError {
+  message: String!
+}
+
 interface SearchDialogError {
   message: String!
 }
@@ -169,6 +173,7 @@ type Content {
 type ContentValue {
   value: [Localization!]!
   mediaType: String!
+  isAuthorized: Boolean
 }
 
 type Dialog {
@@ -267,6 +272,59 @@ type DialogEventPayload {
   type: DialogEventType!
 }
 
+type DialogLookup {
+  dialogId: UUID!
+  instanceRef: String!
+  party: String!
+  serviceResource: DialogLookupServiceResource!
+  serviceOwner: DialogLookupServiceOwner!
+  authorizationEvidence: DialogLookupAuthorizationEvidence!
+}
+
+type DialogLookupAuthorizationEvidence {
+  minimumAuthenticationLevel: Int!
+  currentAuthenticationLevel: Int!
+  viaRole: Boolean!
+  viaAccessPackage: Boolean!
+  viaResourceDelegation: Boolean!
+  viaInstanceDelegation: Boolean!
+  evidence: [DialogLookupAuthorizationEvidenceItem!]!
+}
+
+type DialogLookupAuthorizationEvidenceItem {
+  grantType: DialogLookupGrantType!
+  subject: String!
+}
+
+type DialogLookupForbidden implements DialogLookupError {
+  message: String!
+}
+
+type DialogLookupNotFound implements DialogLookupError {
+  message: String!
+}
+
+type DialogLookupPayload {
+  lookup: DialogLookup
+  errors: [DialogLookupError!]!
+}
+
+type DialogLookupServiceOwner {
+  orgNumber: String!
+  code: String!
+  name: [Localization!]!
+}
+
+type DialogLookupServiceResource {
+  id: String!
+  isDelegable: Boolean!
+  name: [Localization!]!
+}
+
+type DialogLookupValidationError implements DialogLookupError {
+  message: String!
+}
+
 type EndUserContext {
   revision: UUID!
   systemLabels: [SystemLabel!]!
@@ -318,6 +376,7 @@ type Mutations {
 }
 
 type Queries @authorize(policy: "enduser") {
+  dialogLookup(instanceRef: String!): DialogLookupPayload!
   dialogById(dialogId: UUID!): DialogByIdPayload!
   searchDialogs(input: SearchDialogInput!): SearchDialogsPayload!
   limits: Limits!
@@ -658,6 +717,13 @@ enum DialogEventType {
   DIALOG_DELETED
 }
 
+enum DialogLookupGrantType {
+  ROLE
+  ACCESS_PACKAGE
+  RESOURCE_DELEGATION
+  INSTANCE_DELEGATION
+}
+
 enum DialogStatus {
   "Started. In a serial process, this is used to indicate that, for example, a form filling is ongoing."
   IN_PROGRESS

package/swagger.verified.json

@@ -464,6 +464,11 @@
       "V1CommonContent_ContentValue": {
         "additionalProperties": false,
         "properties": {
+          "isAuthorized": {
+            "description": "True if the authenticated user is authorized for this content. If not, the endpoints will\nbe replaced with a fixed placeholder. Can be null if not applicable.\n            ",
+            "nullable": true,
+            "type": "boolean"
+          },
           "mediaType": {
             "description": "Media type of the content, this can also indicate that the content is embeddable.",
             "type": "string"
@@ -479,6 +484,166 @@
         },
         "type": "object"
       },
+      "V1CommonIdentifierLookup_EndUserIdentifierLookup": {
+        "additionalProperties": false,
+        "properties": {
+          "authorizationEvidence": {
+            "$ref": "#/components/schemas/V1CommonIdentifierLookup_IdentifierLookupAuthorizationEvidence"
+          },
+          "dialogId": {
+            "format": "guid",
+            "type": "string"
+          },
+          "instanceRef": {
+            "type": "string"
+          },
+          "party": {
+            "type": "string"
+          },
+          "serviceOwner": {
+            "$ref": "#/components/schemas/V1CommonIdentifierLookup_IdentifierLookupServiceOwner"
+          },
+          "serviceResource": {
+            "$ref": "#/components/schemas/V1CommonIdentifierLookup_IdentifierLookupServiceResource"
+          }
+        },
+        "type": "object"
+      },
+      "V1CommonIdentifierLookup_IdentifierLookupAuthorizationEvidence": {
+        "additionalProperties": false,
+        "properties": {
+          "currentAuthenticationLevel": {
+            "format": "int32",
+            "type": "integer"
+          },
+          "evidence": {
+            "items": {
+              "$ref": "#/components/schemas/V1CommonIdentifierLookup_IdentifierLookupAuthorizationEvidenceItem"
+            },
+            "nullable": true,
+            "type": "array"
+          },
+          "minimumAuthenticationLevel": {
+            "format": "int32",
+            "type": "integer"
+          },
+          "viaAccessPackage": {
+            "type": "boolean"
+          },
+          "viaInstanceDelegation": {
+            "type": "boolean"
+          },
+          "viaResourceDelegation": {
+            "type": "boolean"
+          },
+          "viaRole": {
+            "type": "boolean"
+          }
+        },
+        "type": "object"
+      },
+      "V1CommonIdentifierLookup_IdentifierLookupAuthorizationEvidenceItem": {
+        "additionalProperties": false,
+        "properties": {
+          "grantType": {
+            "$ref": "#/components/schemas/V1CommonIdentifierLookup_IdentifierLookupGrantType"
+          },
+          "subject": {
+            "type": "string"
+          }
+        },
+        "type": "object"
+      },
+      "V1CommonIdentifierLookup_IdentifierLookupGrantType": {
+        "description": "",
+        "enum": [
+          "Role",
+          "AccessPackage",
+          "ResourceDelegation",
+          "InstanceDelegation"
+        ],
+        "type": "string",
+        "x-enumNames": [
+          "Role",
+          "AccessPackage",
+          "ResourceDelegation",
+          "InstanceDelegation"
+        ]
+      },
+      "V1CommonIdentifierLookup_IdentifierLookupServiceOwner": {
+        "additionalProperties": false,
+        "properties": {
+          "code": {
+            "type": "string"
+          },
+          "name": {
+            "items": {
+              "$ref": "#/components/schemas/V1CommonLocalizations_Localization"
+            },
+            "nullable": true,
+            "type": "array"
+          },
+          "orgNumber": {
+            "type": "string"
+          }
+        },
+        "type": "object"
+      },
+      "V1CommonIdentifierLookup_IdentifierLookupServiceResource": {
+        "additionalProperties": false,
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "isDelegable": {
+            "type": "boolean"
+          },
+          "name": {
+            "items": {
+              "$ref": "#/components/schemas/V1CommonLocalizations_Localization"
+            },
+            "nullable": true,
+            "type": "array"
+          }
+        },
+        "type": "object"
+      },
+      "V1CommonIdentifierLookup_ServiceOwnerIdentifierLookup": {
+        "additionalProperties": false,
+        "properties": {
+          "dialogId": {
+            "format": "guid",
+            "type": "string"
+          },
+          "instanceRef": {
+            "type": "string"
+          },
+          "nonSensitiveTitle": {
+            "items": {
+              "$ref": "#/components/schemas/V1CommonLocalizations_Localization"
+            },
+            "nullable": true,
+            "type": "array"
+          },
+          "party": {
+            "type": "string"
+          },
+          "serviceOwner": {
+            "$ref": "#/components/schemas/V1CommonIdentifierLookup_IdentifierLookupServiceOwner"
+          },
+          "serviceResource": {
+            "$ref": "#/components/schemas/V1CommonIdentifierLookup_IdentifierLookupServiceResource"
+          },
+          "title": {
+            "items": {
+              "$ref": "#/components/schemas/V1CommonLocalizations_Localization"
+            },
+            "nullable": true,
+            "type": "array"
+          }
+        },
+        "type": "object"
+      },
       "V1CommonLocalizations_Localization": {
         "additionalProperties": false,
         "properties": {
@@ -546,6 +711,20 @@
         },
         "type": "object"
       },
+      "V1EndUserDialogLookupQueriesGet_DialogLookupRequest": {
+        "additionalProperties": false,
+        "properties": {
+          "acceptedLanguages": {
+            "nullable": true,
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/V1EndUserCommon_AcceptedLanguages"
+              }
+            ]
+          }
+        },
+        "type": "object"
+      },
       "V1EndUserDialogsQueriesGet_Content": {
         "additionalProperties": false,
         "properties": {
@@ -568,7 +747,7 @@
             ]
           },
           "mainContentReference": {
-            "description": "Front-channel embedded content. Used to dynamically embed content in the frontend from an external URL.",
+            "description": "Front-channel embedded content. Used to dynamically embed content in the frontend from an external URL.\nContent value will be masked if the user is not authorized to read main content.",
             "nullable": true,
             "oneOf": [
               {
@@ -2531,6 +2710,20 @@
           "Awaiting"
         ]
       },
+      "V1ServiceOwnerDialogLookupQueriesGet_DialogLookupRequest": {
+        "additionalProperties": false,
+        "properties": {
+          "acceptedLanguages": {
+            "nullable": true,
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/V1EndUserCommon_AcceptedLanguages"
+              }
+            ]
+          }
+        },
+        "type": "object"
+      },
       "V1ServiceOwnerDialogsCommandsCreate_Activity": {
         "additionalProperties": false,
         "properties": {
@@ -4320,7 +4513,7 @@
             ]
           },
           "mainContentReference": {
-            "description": "Front-channel embedded content. Used to dynamically embed content in the frontend from an external URL. Must be HTTPS.",
+            "description": "Front-channel embedded content. Used to dynamically embed content in the frontend from an external URL. Must be HTTPS.\nIsAuthorized is evaluated only when you use the EndUserId query-parameter, otherwise it is null.",
             "nullable": true,
             "oneOf": [
               {
@@ -6477,6 +6670,102 @@
         ]
       }
     },
+    "/api/v1/enduser/dialoglookup": {
+      "get": {
+        "description": "Resolves dialog metadata and authorization evidence for a supported instance reference.",
+        "operationId": "V1EndUserDialogLookupQueriesGet_DialogLookup",
+        "parameters": [
+          {
+            "in": "query",
+            "name": "instanceRef",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "in": "header",
+            "name": "accept-Language",
+            "schema": {
+              "nullable": true,
+              "oneOf": [
+                {
+                  "$ref": "#/components/schemas/V1EndUserCommon_AcceptedLanguages"
+                }
+              ]
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/V1CommonIdentifierLookup_EndUserIdentifierLookup"
+                }
+              }
+            },
+            "description": "Successfully resolved dialog lookup metadata."
+          },
+          "400": {
+            "content": {
+              "application/problem\u002Bjson": {
+                "schema": {
+                  "$ref": "#/components/schemas/ProblemDetails"
+                }
+              }
+            },
+            "description": "Validation error occurred. See problem details for a list of errors."
+          },
+          "401": {
+            "description": "Missing or invalid authentication token. Requires a Maskinporten-token with the scope \u0022digdir:dialogporten\u0022."
+          },
+          "403": {
+            "description": "Authenticated end user is not authorized for the supplied instance reference."
+          },
+          "404": {
+            "content": {
+              "application/problem\u002Bjson": {
+                "schema": {
+                  "$ref": "#/components/schemas/ProblemDetails"
+                }
+              }
+            },
+            "description": "No dialog match was found for the supplied instance reference."
+          },
+          "503": {
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "example": "Service Unavailable",
+                  "type": "string"
+                }
+              }
+            },
+            "description": "Service Unavailable, used when Dialogporten is in maintenance mode",
+            "headers": {
+              "Retry-After": {
+                "description": "Delay before retrying the request. Datetime format RFC1123",
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "JWTBearerAuth": [
+              "digdir:dialogporten"
+            ]
+          }
+        ],
+        "summary": "Looks up a dialog by instance reference",
+        "tags": [
+          "Enduser"
+        ]
+      }
+    },
     "/api/v1/enduser/dialogs": {
       "get": {
         "description": "Performs a search for dialogs, returning a paginated list of dialogs. \n\n* All date parameters must contain explicit time zone. Example: 2023-10-27T10:00:00Z or 2023-10-27T10:00:00\u002B01:00\n* See \u0022continuationToken\u0022 in the response for how to get the next page of results.\n* hasNextPage will be set to true if there are more items to get.",
@@ -7815,6 +8104,102 @@
         ]
       }
     },
+    "/api/v1/serviceowner/dialoglookup": {
+      "get": {
+        "description": "Resolves dialog metadata for a supported instance reference in service owner context.",
+        "operationId": "V1ServiceOwnerDialogLookupQueriesGet_DialogLookup",
+        "parameters": [
+          {
+            "in": "query",
+            "name": "instanceRef",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "in": "header",
+            "name": "accept-Language",
+            "schema": {
+              "nullable": true,
+              "oneOf": [
+                {
+                  "$ref": "#/components/schemas/V1EndUserCommon_AcceptedLanguages"
+                }
+              ]
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/V1CommonIdentifierLookup_ServiceOwnerIdentifierLookup"
+                }
+              }
+            },
+            "description": "Successfully resolved instance reference lookup metadata."
+          },
+          "400": {
+            "content": {
+              "application/problem\u002Bjson": {
+                "schema": {
+                  "$ref": "#/components/schemas/ProblemDetails"
+                }
+              }
+            },
+            "description": "Validation error occurred. See problem details for a list of errors."
+          },
+          "401": {
+            "description": "Missing or invalid authentication token. Requires a Maskinporten-token with the scope \u0022digdir:dialogporten.serviceprovider\u0022."
+          },
+          "403": {
+            "description": "Authenticated service owner does not own the resolved dialog."
+          },
+          "404": {
+            "content": {
+              "application/problem\u002Bjson": {
+                "schema": {
+                  "$ref": "#/components/schemas/ProblemDetails"
+                }
+              }
+            },
+            "description": "No dialog match was found for the supplied instance reference."
+          },
+          "503": {
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "example": "Service Unavailable",
+                  "type": "string"
+                }
+              }
+            },
+            "description": "Service Unavailable, used when Dialogporten is in maintenance mode",
+            "headers": {
+              "Retry-After": {
+                "description": "Delay before retrying the request. Datetime format RFC1123",
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "JWTBearerAuth": [
+              "digdir:dialogporten.serviceprovider"
+            ]
+          }
+        ],
+        "summary": "Looks up a dialog by instance reference",
+        "tags": [
+          "Serviceowner"
+        ]
+      }
+    },
     "/api/v1/serviceowner/dialogs": {
       "get": {
         "description": "Performs a search for dialogs, returning a paginated list of dialogs.\n\n* All date parameters must contain explicit time zone. Example: 2023-10-27T10:00:00Z or 2023-10-27T10:00:00\u002B01:00\n* See \u0022continuationToken\u0022 in the response for how to get the next page of results.\n* hasNextPage will be set to true if there are more items to get.",