Digest Authentication Policy

General Information

Policy Type

policy-auth-digest

UI Documentation

📖 For detailed information: [UI Documentation Link - Link will be added here]

Description

Digest Authentication policy validates HTTP Digest Authentication credentials. Digest authentication is more secure than Basic authentication as it uses hashing instead of Base64 encoding. It extracts username, password, nonce, and created timestamp from the request and validates them against an authentication source.

Endpoints

List Policies

GET /apiops/projects/{projectName}/apiProxies/{apiProxyName}/policies/

Add Policy

POST /apiops/projects/{projectName}/apiProxies/{apiProxyName}/policies/{policyName}/

Update Policy

PUT /apiops/projects/{projectName}/apiProxies/{apiProxyName}/policies/{policyName}/

Delete Policy

DELETE /apiops/projects/{projectName}/apiProxies/{apiProxyName}/policies/{policyName}/

List Policies

Endpoint

GET /apiops/projects/{projectName}/apiProxies/{apiProxyName}/policies/

Request

Headers

Header Value
Authorization Bearer {token}

Path Parameters

Parameter Type Required Description
projectName string Yes Project name
apiProxyName string Yes API Proxy name

Response

Success Response (200 OK)

{
  "success": true,
  "resultList": [
    {
      "apiProxy": {
        "name": "MyAPI",
        "requestPolicyList": [
          {
            "type": "policy-auth-digest",
            "name": "digest-auth-policy",
            "description": "Digest authentication policy",
            "active": true,
            "usernameVar": {
              "type": "HEADER",
              "headerName": "Authorization"
            },
            "passwordVar": {
              "type": "HEADER",
              "headerName": "Authorization"
            },
            "nonceVar": null,
            "createdVar": null,
            "clearAuth": false,
            "addUserToHeader": true,
            "userHeaderName": "X-Authenticated-User"
          }
        ],
        "responsePolicyList": [],
        "errorPolicyList": []
      }
    }
  ],
  "resultCount": 1
}

cURL Example

curl -X GET \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxies/MyAPI/policies/" \
  -H "Authorization: Bearer YOUR_TOKEN"

Add Policy

Endpoint

POST /apiops/projects/{projectName}/apiProxies/{apiProxyName}/policies/{policyName}/

Request

Headers

Header Value
Authorization Bearer {token}
Content-Type application/json

Path Parameters

Parameter Type Required Description
projectName string Yes Project name
apiProxyName string Yes API Proxy name
policyName string Yes Policy name

Request Body

Full JSON Body Example
{
  "operationMetadata": {
    "targetScope": "ALL",
    "targetPipeline": "REQUEST",
    "deploy": true,
    "deployTargetEnvironmentNameList": ["production"],
    "order": 1
  },
  "policy": {
    "type": "policy-auth-digest",
    "description": "Digest authentication policy - validate credentials from Authorization header",
    "active": true,
    "usernameVar": {
      "type": "HEADER",
      "headerName": "Authorization"
    },
    "passwordVar": {
      "type": "HEADER",
      "headerName": "Authorization"
    },
    "nonceVar": {
      "type": "HEADER",
      "headerName": "Authorization"
    },
    "createdVar": {
      "type": "HEADER",
      "headerName": "Authorization"
    },
    "clearAuth": false,
    "addUserToHeader": true,
    "userHeaderName": "X-Authenticated-User"
  }
}
Request Body Fields
operationMetadata
Field Type Required Default Description
targetScope string Yes - Policy scope: ALL or ENDPOINT
targetEndpoint string No* - Endpoint path (required if targetScope=ENDPOINT)
targetEndpointHTTPMethod string No* - HTTP method (required if targetScope=ENDPOINT)
targetPipeline string Yes - Pipeline: REQUEST, RESPONSE, or ERROR
deploy boolean No true Whether to deploy after adding policy
deployTargetEnvironmentNameList array No [] List of environment names to deploy to
order integer No null Policy execution order (starts from 1)

Enum: targetScope

  • ALL - Policy applies to all endpoints
  • ENDPOINT - Policy applies only to specified endpoint

Enum: targetPipeline

  • REQUEST - Executes in request pipeline
  • RESPONSE - Executes in response pipeline
  • ERROR - Executes in error pipeline

Enum: targetEndpointHTTPMethod

  • GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD
policy
Field Type Required Default Description
type string Yes - Policy type: policy-auth-digest
description string No - Policy description
active boolean No true Whether policy is active
usernameVar object Yes - Variable to extract username from request
passwordVar object Yes - Variable to extract password from request
nonceVar object No - Variable to extract nonce from request (optional)
createdVar object No - Variable to extract created timestamp from request (optional)
clearAuth boolean No false Clear authentication header after validation
addUserToHeader boolean No false Add authenticated user to header
userHeaderName string No* - Header name to add authenticated user (required if addUserToHeader=true)

Note

  • usernameVar and passwordVar are required.
  • nonceVar and createdVar are optional but recommended for enhanced security.
  • userHeaderName is required when addUserToHeader is true.
usernameVar, passwordVar, nonceVar, createdVar
Field Type Required Description
type string Yes Variable type: HEADER, PARAMETER, BODY, CONTEXT, SCRIPT
headerName string No* Header name (required if type=HEADER)
paramName string No* Parameter name (required if type=PARAMETER)
contextValue string No* Context value (required if type=CONTEXT)

type

  • HEADER - Extract from HTTP header (typically “Authorization”)
  • PARAMETER - Extract from query/path parameter
  • BODY - Extract from request body
  • CONTEXT - Extract from context (e.g., CLIENT_IP)
  • SCRIPT - Extract using script

contextValue

  • CLIENT_IP - Client IP address
  • REQUEST_URI - Request URI
  • REQUEST_METHOD - HTTP method
  • USER_AGENT - User agent string

Digest Authentication Format

The Authorization header contains digest authentication parameters:

Authorization: Digest username="user", realm="realm", nonce="nonce", uri="/path", response="response", algorithm=MD5, qop=auth

Response

Success Response (200 OK)

{
  "success": true,
  "deploymentResult": {
    "success": true,
    "deploymentResults": [
      {
        "environmentName": "production",
        "success": true,
        "message": "Deployment successful"
      }
    ]
  }
}

cURL Example

curl -X POST \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxies/MyAPI/policies/digest-auth-policy/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "operationMetadata": {
      "targetScope": "ALL",
      "targetPipeline": "REQUEST",
      "deploy": true,
      "deployTargetEnvironmentNameList": ["production"],
      "order": 1
    },
    "policy": {
      "type": "policy-auth-digest",
      "description": "Digest authentication policy",
      "active": true,
      "usernameVar": {
        "type": "HEADER",
        "headerName": "Authorization"
      },
      "passwordVar": {
        "type": "HEADER",
        "headerName": "Authorization"
      },
      "clearAuth": false,
      "addUserToHeader": true,
      "userHeaderName": "X-Authenticated-User"
    }
  }'

Update Policy

Endpoint

PUT /apiops/projects/{projectName}/apiProxies/{apiProxyName}/policies/{policyName}/

Request

Headers

Header Value
Authorization Bearer {token}
Content-Type application/json

Path Parameters

Parameter Type Required Description
projectName string Yes Project name
apiProxyName string Yes API Proxy name
policyName string Yes Policy name

Request Body

Full JSON Body Example
{
  "operationMetadata": {
    "targetScope": "ALL",
    "targetPipeline": "REQUEST",
    "deploy": true,
    "deployTargetEnvironmentNameList": ["production"],
    "order": 1
  },
  "policy": {
    "type": "policy-auth-digest",
    "description": "Updated digest authentication policy",
    "active": true,
    "usernameVar": {
      "type": "HEADER",
      "headerName": "Authorization"
    },
    "passwordVar": {
      "type": "HEADER",
      "headerName": "Authorization"
    },
    "nonceVar": {
      "type": "HEADER",
      "headerName": "Authorization"
    },
    "createdVar": {
      "type": "HEADER",
      "headerName": "Authorization"
    },
    "clearAuth": true,
    "addUserToHeader": true,
    "userHeaderName": "X-User"
  }
}

Note: Request body structure is the same as Add Policy. All fields should be provided for update.

Response

Success Response (200 OK)

{
  "success": true,
  "deploymentResult": {
    "success": true,
    "deploymentResults": [
      {
        "environmentName": "production",
        "success": true,
        "message": "Deployment successful"
      }
    ]
  }
}

cURL Example

curl -X PUT \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxies/MyAPI/policies/digest-auth-policy/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "operationMetadata": {
      "targetScope": "ALL",
      "targetPipeline": "REQUEST",
      "deploy": true,
      "deployTargetEnvironmentNameList": ["production"],
      "order": 1
    },
    "policy": {
      "type": "policy-auth-digest",
      "description": "Updated digest authentication policy",
      "active": true,
      "usernameVar": {
        "type": "HEADER",
        "headerName": "Authorization"
      },
      "passwordVar": {
        "type": "HEADER",
        "headerName": "Authorization"
      },
      "clearAuth": true,
      "addUserToHeader": true,
      "userHeaderName": "X-User"
    }
  }'

Delete Policy

Endpoint

DELETE /apiops/projects/{projectName}/apiProxies/{apiProxyName}/policies/{policyName}/

Request

Headers

Header Value
Authorization Bearer {token}
Content-Type application/json

Path Parameters

Parameter Type Required Description
projectName string Yes Project name
apiProxyName string Yes API Proxy name
policyName string Yes Policy name

Request Body

Full JSON Body Example
{
  "operationMetadata": {
    "targetScope": "ALL",
    "targetPipeline": "REQUEST",
    "deploy": false
  }
}
Request Body Fields
operationMetadata
Field Type Required Description  
targetScope string Yes Policy scope: ALL or ENDPOINT  
targetPipeline string Yes Pipeline: REQUEST, RESPONSE, or ERROR  
deploy boolean No false Whether to deploy after deletion

Response

Success Response (200 OK)

{
  "success": true,
  "deploymentResult": {
    "success": true,
    "deploymentResults": []
  }
}

cURL Example

curl -X DELETE \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxies/MyAPI/policies/digest-auth-policy/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "operationMetadata": {
      "targetScope": "ALL",
      "targetPipeline": "REQUEST",
      "deploy": false
    }
  }'

Notes and Warnings

  • Authentication Source: This policy validates credentials against an authentication source configured in the policy (LDAP, Database, Memory, or API). Configure the authentication source separately.
  • Digest Authentication: More secure than Basic authentication as it uses hashing (MD5) instead of Base64 encoding
  • Required Fields: usernameVar and passwordVar are required. nonceVar and createdVar are optional but recommended for enhanced security.
  • Authorization Header: Digest Authentication uses the Authorization header with format: Digest username="...", realm="...", nonce="...", uri="...", response="...", ...
  • Clear Auth: When clearAuth: true, the Authorization header is removed after validation (prevents forwarding credentials to backend)
  • Add User to Header: When addUserToHeader: true, the authenticated username is added to the specified header
  • User Header Name: Required when addUserToHeader: true. This header will contain the authenticated username.
  • Variable Extraction: All variables extract from the same Authorization header. The policy parses the digest parameters.
  • Deployment: Policy changes require deployment to take effect. Set deploy: true or deploy manually.