Queue User Delegation SAS

specification/storage/data-plane/Microsoft.QueueStorage/stable/2026-02-06/queue.json

@@ -1,4 +1,4 @@
 {
   "swagger": "2.0",
   "info": {
     "title": "Azure Queue Storage",
@@ -239,6 +239,93 @@
         }
       ]
     },
+    "/?restype=service&comp=userdelegationkey": {
+      "post": {
+        "tags": [
+          "service"
+        ],
+        "operationId": "Service_GetUserDelegationKey",
+        "description": "Retrieves a user delegation key for the Queue service. This is only a valid operation when using bearer token authentication.",
+        "parameters": [
+          {
+            "$ref": "#/parameters/KeyInfo"
+          },
+          {
+            "$ref": "#/parameters/Timeout"
+          },
+          {
+            "$ref": "#/parameters/ApiVersionParameter"
+          },
+          {
+            "$ref": "#/parameters/ClientRequestId"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Success.",
+            "headers": {
+              "x-ms-client-request-id": {
+                "x-ms-client-name": "ClientRequestId",
+                "type": "string",
+                "description": "If a client request id header is sent in the request, this header will be present in the response with the same value."
+              },
+              "x-ms-request-id": {
+                "x-ms-client-name": "RequestId",
+                "type": "string",
+                "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request."
+              },
+              "x-ms-version": {
+                "x-ms-client-name": "Version",
+                "type": "string",
+                "description": "Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
+              },
+              "Date": {
+                "type": "string",
+                "format": "date-time-rfc1123",
+                "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated"
+              }
+            },
+            "schema": {
+              "$ref": "#/definitions/UserDelegationKey"
+            }
+          },
+          "default": {
+            "description": "Failure",
+            "headers": {
+              "x-ms-error-code": {
+                "x-ms-client-name": "ErrorCode",
+                "type": "string"
+              }
+            },
+            "schema": {
+              "$ref": "#/definitions/StorageError"
+            }
+          }
+        }
+      },
+      "parameters": [
+        {
+          "name": "restype",
+          "description": "restype",
+          "in": "query",
+          "required": true,
+          "type": "string",
+          "enum": [
+            "service"
+          ]
+        },
+        {
+          "name": "comp",
+          "description": "comp",
+          "in": "query",
+          "required": true,
+          "type": "string",
+          "enum": [
+            "userdelegationkey"
+          ]
+        }
+      ]
+    },
     "/?comp=list": {
       "get": {
         "tags": [
@@ -1672,6 +1759,68 @@
           "$ref": "#/definitions/GeoReplication"
         }
       }
+    },
+    "KeyInfo": {
+      "type": "object",
+      "required": [
+        "Expiry"
+      ],
+      "description": "Key information",
+      "properties": {
+        "Start": {
+          "description": "The date-time the key is active in ISO 8601 UTC time",
+          "type": "string"
+        },
+        "Expiry": {
+          "description": "The date-time the key expires in ISO 8601 UTC time",
+          "type": "string"
+        }
+      }
+    },
+    "UserDelegationKey": {
+      "type": "object",
+      "required": [
+        "SignedOid",
+        "SignedTid",
+        "SignedStart",
+        "SignedExpiry",
+        "SignedService",
+        "SignedVersion",
+        "Value"
+      ],
+      "description": "A user delegation key",
+      "properties": {
+        "SignedOid": {
+          "description": "The Azure Active Directory object ID in GUID format.",
+          "type": "string"
+        },
+        "SignedTid": {
+          "description": "The Azure Active Directory tenant ID in GUID format",
+          "type": "string"
+        },
+        "SignedStart": {
+          "description": "The date-time the key is active",
+          "type": "string",
+          "format": "date-time"
+        },
+        "SignedExpiry": {
+          "description": "The date-time the key expires",
+          "type": "string",
+          "format": "date-time"
+        },
+        "SignedService": {
+          "description": "Abbreviation of the Azure Storage service that accepts the key",
+          "type": "string"
+        },
+        "SignedVersion": {
+          "description": "The service version that created the key",
+          "type": "string"
+        },
+        "Value": {
+          "description": "The key as a base64 string",
+          "type": "string"
+        }
+      }
     }
   },
   "parameters": {
@@ -1901,6 +2050,16 @@
       "maximum": 604800,
       "x-ms-parameter-location": "method",
       "description": "Optional. If specified, the request must be made using an x-ms-version of 2011-08-18 or later. If not specified, the default value is 0. Specifies the new visibility timeout value, in seconds, relative to server time. The new value must be larger than or equal to 0, and cannot be larger than 7 days. The visibility timeout of a message cannot be set to a value later than the expiry time. visibilitytimeout should be set to a value smaller than the time-to-live value."
+    },
+    "KeyInfo": {
+      "description": "Key information",
+      "name": "KeyInfo",
+      "in": "body",
+      "x-ms-parameter-location": "method",
+      "required": true,
+      "schema": {
+        "$ref": "#/definitions/KeyInfo"
+      }
     }
   }
 }