Get an active session for a single user.
/accounts/{identifier}/access/users/{id}/active_sessions/{nonce}
get
Zero Trust users
zero-trust-users-get-active-session
nullnull[
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "UUID",
"example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"maxLength": 36,
"readOnly": true,
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
},
{
"in": "path",
"name": "nonce",
"required": true,
"schema": {
"example": "X1aXj1lFVcqqyoXF",
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"allOf": [
{
"properties": {
"account_id": {
"example": "1234567890",
"type": "string"
},
"auth_status": {
"example": "NONE",
"type": "string"
},
"common_name": {
"example": "",
"type": "string"
},
"devicePosture": {
"additionalProperties": {
"properties": {
"check": {
"properties": {
"exists": {
"type": "boolean"
},
"path": {
"type": "string"
}
},
"type": "object"
},
"data": {
"type": "object"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
},
"id": {
"type": "string"
},
"rule_name": {
"type": "string"
},
"success": {
"type": "boolean"
},
"timestamp": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"type": "object"
},
"device_id": {
"example": "",
"type": "string"
},
"device_sessions": {
"additionalProperties": {
"example": {
"last_authenticated": 1638832687
},
"properties": {
"last_authenticated": {
"type": "number"
}
},
"type": "object"
},
"type": "object"
},
"email": {
"example": "test@cloudflare.com",
"type": "string"
},
"geo": {
"example": {
"country": "US"
},
"properties": {
"country": {
"type": "string"
}
},
"type": "object"
},
"iat": {
"example": 1694791905,
"type": "number"
},
"idp": {
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"ip": {
"example": "127.0.0.0",
"type": "string"
},
"is_gateway": {
"example": false,
"type": "boolean"
},
"is_warp": {
"example": false,
"type": "boolean"
},
"mtls_auth": {
"properties": {
"auth_status": {
"type": "string"
},
"cert_issuer_dn": {
"type": "string"
},
"cert_issuer_ski": {
"type": "string"
},
"cert_presented": {
"type": "boolean"
},
"cert_serial": {
"type": "string"
}
},
"type": "object"
},
"service_token_id": {
"example": "",
"type": "string"
},
"service_token_status": {
"example": false,
"type": "boolean"
},
"user_uuid": {
"example": "57cf8cf2-f55a-4588-9ac9-f5e41e9f09b4",
"type": "string"
},
"version": {
"example": 2,
"type": "number"
}
},
"type": "object"
},
{
"properties": {
"isActive": {
"example": true,
"type": "boolean"
}
},
"type": "object"
}
],
"type": "object"
}
}
}
]
}
}
},
"description": "Get active session response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
}
},
"description": "Get active session response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]