---
title: Get session identifier settings
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[API Gateway](https://developers.cloudflare.com/api/resources/api_gateway)
[Configurations](https://developers.cloudflare.com/api/resources/api_gateway/subresources/configurations)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# Get session identifier settings
GET/zones/{zone\_id}/api\_gateway/configuration
Returns the authentication identifier characteristics configured for the zone. Header, cookie, or JWT claim values identify distinct API sessions.
##### Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
**Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
**Example:**X-Auth-Email: user@example.com
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
**Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required)
`Account API Gateway``Account API Gateway Read``Domain API Gateway``Domain API Gateway Read`
##### P ath ParametersExpand Collapse
zone\_id: string
Identifier.
maxLength32
[Link to this property](<#(resource)%20api_gateway.configurations%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>)
##### Q uery ParametersExpand Collapse
normalize: optional boolean
Ensures that the configuration is written or retrieved in normalized fashion
[Link to this property](<#(resource)%20api_gateway.configurations%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20normalize%20%3E%20(schema)>)
##### ReturnsExpand Collapse
errors: Message { code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20api_gateway.configurations%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: Message { code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20api_gateway.configurations%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
result: Configuration { auth\_id\_characteristics }
auth\_id\_characteristics: array of object {name, type } or object {name, type }
One of the following:
APIShieldAuthIDCharacteristic object {name, type }
Auth ID Characteristic
name: string
The name of the characteristic field, i.e., the header or cookie name.
maxLength128
Link to this property
type: "header"or "cookie"
The type of characteristic.
One of the following:
"header"
Link to this property
"cookie"
Link to this property
Link to this property
Link to this property
APIShieldAuthIDCharacteristicJWTClaim object {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
Link to this property
type: "jwt"
The type of characteristic.
Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20api_gateway.configurations%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
success: true
Whether the API call was successful.
[Link to this property](<#(resource)%20api_gateway.configurations%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
### Get session identifier settings
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/api_gateway/configuration \
-H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
```
200 example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"result": {
"auth_id_characteristics": [
{
"name": "authorization",
"type": "header"
}
]
},
"success": true
}
```
##### Returns Examples
200 example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"result": {
"auth_id_characteristics": [
{
"name": "authorization",
"type": "header"
}
]
},
"success": true
}
```