Skip to content

Latest commit

 

History

History
112 lines (103 loc) · 3.79 KB

README.md

File metadata and controls

112 lines (103 loc) · 3.79 KB

Common policy expressions

This cheat-sheet contains common policy expressions that are often used when authoring Azure API Management policies.

Interact with HTTP headers

Get HTTP header

context.Request.Headers.GetValueOrDefault("header-name","optional-default-value")

Check HTTP header existence

context.Request.Headers.ContainsKey("header-name") == true

Check if HTTP header has expected value

context.Request.Headers.GetValueOrDefault("header-name", "").Equals("expected-header-value", StringComparison.OrdinalIgnoreCase)

Interact with URI parameters

Get URI parameter

context.Request.MatchedParameters.GetValueOrDefault("parameter-name","optional-default-value")

Check URI parameter existence

context.Request.MatchedParameters.ContainsKey("parameter-name") == true

Check if URI parameter has expected value

context.Request.MatchedParameters.GetValueOrDefault("parameter-name", "").Equals("expected-value", StringComparison.OrdinalIgnoreCase) == true

Interact with query string parameters

Get query string parameter

context.Request.Url.Query.GetValueOrDefault("parameter-name", "optional-default-value")

Check query string parameter existence

context.Request.Url.Query.ContainsKey("parameter-name") == true

Check if query string parameter has expected value

context.Request.Url.Query.GetValueOrDefault("parameter-name", "").Equals("expected-value", StringComparison.OrdinalIgnoreCase) == true

Interact with policy variables

Get policy variable (assuming type string)

context.Variables.GetValueOrDefault<string>("variable-name","optional-default-value")

Check policy variable existence

context.Variables.ContainsKey("variable-name") == true

Check if policy variable has expected value (assuming type string)

context.Variables.GetValueOrDefault<string>("variable-name","").Equals("expected-value", StringComparison.OrdinalIgnoreCase)

Interact with JSON bodies

Get value from JSON body

(string)context.Request.Body.As<JObject>(preserveContent: true).SelectToken("root.child jsonpath")

Get value from JSON response variable

(string)((IResponse)context.Variables["response-variable-name"]).Body.As<JObject>().SelectToken("root.child jsonpath")

Add property to JSON body

JObject body = context.Request.Body.As<JObject>(); 
body.Add(new JProperty("property-name", "property-value"));
return body.ToString();

Interact with JSON Web Tokens

Read claim from bearer token

context.Request.Headers.GetValueOrDefault("Authorization")?.Split(' ')?[1].AsJwt()?.Claims["claim-name"].FirstOrDefault()

Interact with client certificates

Check client certificate existence

context.Request.Certificate != null

Check if client certificate is valid, including a certificate revocation check

context.Request.Certificate.Verify() == true

Check if client certificate is valid, excluding a certificate revocation check

context.Request.Certificate.VerifyNoRevocation() == true

Check if client certificate issuer has expected value

context.Request.Certificate.Issuer == "trusted-issuer"

Check if client certificate subject has expected value

context.Request.Certificate.SubjectName.Name == "expected-subject-name"

Check if client certificate thumbprint has expected value

context.Request.Certificate.Thumbprint == "EXPECTED-THUMBPRINT-IN-UPPER-CASE"

Check if client certificate is uploaded in API Management, based on thumbprint

context.Deployment.Certificates.Any(c => c.Value.Thumbprint == context.Request.Certificate.Thumbprint) == true