Microsoft.Authorization (stable:2025-03-01)

2025/07/03 • 1 updated methods

PolicyTokens_Acquire (updated)
Description :  This operation acquires a policy token in the given subscription for the given request body.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PolicyTokens_Acquire",
  "$parameters": {
    "parameters": {
      "$properties": [
        {
          "#name": "operation",
          "Required": {
            "new": true,
            "old": false
          },
          "$properties": [
            {
              "#name": "uri",
              "Required": {
                "new": true,
                "old": false
              }
            },
            {
              "#name": "httpMethod",
              "Required": {
                "new": true,
                "old": false
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/acquirePolicyToken
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
parameters:
{
Description: The policy token properties. ,
Required: True ,
}
{
operation:
{
Description: The resource operation to acquire a token for. ,
Required: True ,
}
{
uri:
{
Description: The request URI of the resource operation. ,
Required: True ,
}
string ,
httpMethod:
{
Description: The http method of the resource operation. ,
Required: True ,
}
string ,
content:
{
Description: The payload of the resource operation. ,
Required: False ,
}
object ,
}
,
changeReference:
{
Description: The change reference. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
result:
{
Description: The result of the completed token acquisition operation. Possible values are Succeeded and Failed. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Status message with additional details about the token acquisition operation result. ,
Required: False ,
}
string ,
retryAfter:
{
Description: The date and time after which the client can try to acquire a token again in the case of retry-able failures. ,
Format: date-time ,
Required: False ,
}
string ,
results:
{
Description: An array of external evaluation endpoint invocation results. ,
Required: False ,
}
[
{
policyInfo:
{
Description: The details of the policy requiring the external endpoint invocation. ,
Required: False ,
}
{
policyDefinitionId:
{
Description: The policy definition Id. ,
Required: False ,
}
string ,
policySetDefinitionId:
{
Description: The policy set definition Id. ,
Required: False ,
}
string ,
policyDefinitionReferenceId:
{
Description: The policy definition instance Id inside a policy set. ,
Required: False ,
}
string ,
policySetDefinitionName:
{
Description: The policy set definition name. ,
Required: False ,
}
string ,
policySetDefinitionDisplayName:
{
Description: The policy set definition display name. ,
Required: False ,
}
string ,
policySetDefinitionVersion:
{
Description: The policy set definition version. ,
Required: False ,
}
string ,
policySetDefinitionCategory:
{
Description: The policy set definition category. ,
Required: False ,
}
string ,
policyDefinitionName:
{
Description: The policy definition name. ,
Required: False ,
}
string ,
policyDefinitionDisplayName:
{
Description: The policy definition display name. ,
Required: False ,
}
string ,
policyDefinitionVersion:
{
Description: The policy definition version. ,
Required: False ,
}
string ,
policyDefinitionEffect:
{
Description: The policy definition action. ,
Required: False ,
}
string ,
policyDefinitionGroupNames:
{
Description: An array of policy definition group names. ,
Required: False ,
}
[
string ,
]
,
policyAssignmentId:
{
Description: The policy assignment Id. ,
Required: False ,
}
string ,
policyAssignmentName:
{
Description: The policy assignment name. ,
Required: False ,
}
string ,
policyAssignmentDisplayName:
{
Description: The policy assignment display name. ,
Required: False ,
}
string ,
policyAssignmentVersion:
{
Description: The policy assignment version. ,
Required: False ,
}
string ,
policyAssignmentScope:
{
Description: The policy assignment scope. ,
Required: False ,
}
string ,
resourceLocation:
{
Description: The resource location. ,
Required: False ,
}
string ,
ancestors:
{
Description: The management group ancestors. ,
Required: False ,
}
string ,
complianceReasonCode:
{
Description: The policy compliance reason code. ,
Required: False ,
}
string ,
policyExemptionIds:
{
Description: An array of policy exemption Ids. ,
Required: False ,
}
[
string ,
]
,
}
,
result:
{
Description: The result of the external endpoint. Possible values are Succeeded and Failed. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The status message with additional details about the invocation result. ,
Required: False ,
}
string ,
retryAfter:
{
Description: The date and time after which a failed endpoint invocation can be retried. ,
Format: date-time ,
Required: False ,
}
string ,
claims:
{
Description: The set of claims that will be attached to the policy token as an attestation for the result of the endpoint invocation. ,
Required: False ,
}
object ,
expiration:
{
Description: The expiration of the results. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
changeReference:
{
Description: The change reference associated with the operation for which the token is acquired. ,
Required: False ,
}
string ,
token:
{
Description: The issued policy token. ,
Required: False ,
}
string ,
tokenId:
{
Description: The unique Id assigned to the policy token. ,
Required: False ,
}
string ,
expiration:
{
Description: The expiration of the policy token. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}