---
title: Configurations
---

[Skip to content](#%5Ftop) 

[API Reference](https://developers.cloudflare.com/api/typescript)

[API Gateway](https://developers.cloudflare.com/api/typescript/resources/api%5Fgateway)

Copy Markdown

Open in **Claude**

Open in **ChatGPT**

Open in **Cursor**

---

**Copy Markdown**

**View as Markdown**

# Configurations

##### [Get session identifier settings](https://developers.cloudflare.com/api/typescript/resources/api%5Fgateway/subresources/configurations/methods/get)

client.apiGateway.configurations.get(ConfigurationGetParams { zone\_id, normalize } params, RequestOptionsoptions?): [Configuration](https://developers.cloudflare.com/api/typescript/resources/api%5Fgateway#%28resource%29%20api%5Fgateway.configurations%20%3E%20%28model%29%20configuration%20%3E%20%28schema%29) { auth\_id\_characteristics } 

GET/zones/{zone\_id}/api\_gateway/configuration

##### [Update session identifier settings](https://developers.cloudflare.com/api/typescript/resources/api%5Fgateway/subresources/configurations/methods/update)

client.apiGateway.configurations.update(ConfigurationUpdateParams { zone\_id, auth\_id\_characteristics, normalize } params, RequestOptionsoptions?): [Configuration](https://developers.cloudflare.com/api/typescript/resources/api%5Fgateway#%28resource%29%20api%5Fgateway.configurations%20%3E%20%28model%29%20configuration%20%3E%20%28schema%29) { auth\_id\_characteristics } 

PUT/zones/{zone\_id}/api\_gateway/configuration

##### ModelsExpand Collapse 

Configuration { auth\_id\_characteristics } 

auth\_id\_characteristics: Array<APIShieldAuthIDCharacteristic { name, type } | APIShieldAuthIDCharacteristicJWTClaim { name, type } \>

One of the following:

APIShieldAuthIDCharacteristic { name, type } 

Auth ID Characteristic

name: string

The name of the characteristic field, i.e., the header or cookie name.

maxLength128

type: "header" | "cookie"

The type of characteristic.

One of the following:

"header"

"cookie"

APIShieldAuthIDCharacteristicJWTClaim { name, type } 

Auth ID Characteristic extracted from JWT Token Claims

name: string

Claim location expressed as `$(token_config_id):$(json_path)`, where `token_config_id`is the ID of the token configuration used in validating the JWT, and `json_path` is a RFC 9535 JSONPath (<https://goessner.net/articles/JsonPath/>, <https://www.rfc-editor.org/rfc/rfc9535.html>). The JSONPath expression may be in dot or bracket notation, may only specify literal keys or array indexes, and must return a singleton value, which will be interpreted as a string.

maxLength128

type: "jwt"

The type of characteristic.