Tests if a specific user has permission to access an application.
/zones/{identifier}/access/apps/{app_id}/user_policy_checks
get
Zone-Level Access applications
zone-level-access-applications-test-access-policies
nullnull[
{
"in": "path",
"name": "app_id",
"required": true,
"schema": {
"oneOf": [
{
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
},
{
"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"
}
}
]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": {
"properties": {
"app_state": {
"properties": {
"app_uid": {
"description": "UUID",
"example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"maxLength": 36,
"readOnly": true,
"type": "string"
},
"aud": {
"example": "737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe389",
"type": "string"
},
"hostname": {
"example": "test.com",
"type": "string"
},
"name": {
"example": "Test App",
"type": "string"
},
"policies": {
"example": [
{
"decision": "allow",
"exclude": [],
"include": [
{
"_type": "email",
"email": "testuser@gmail.com"
}
],
"precedence": 0,
"require": [],
"status": "Success"
}
],
"items": {},
"type": "array"
},
"status": {
"example": "Success",
"type": "string"
}
},
"type": "object"
},
"user_identity": {
"properties": {
"account_id": {
"example": "41ecfbb341f033e52b46742756aabb8b",
"type": "string"
},
"device_sessions": {
"example": {},
"type": "object"
},
"email": {
"example": "testuser@gmail.com",
"type": "string"
},
"geo": {
"properties": {
"country": {
"example": "US",
"type": "string"
}
},
"type": "object"
},
"iat": {
"type": "integer"
},
"id": {
"example": "1164449231815010287495",
"type": "string"
},
"is_gateway": {
"example": false,
"type": "boolean"
},
"is_warp": {
"example": false,
"type": "boolean"
},
"name": {
"example": "Test User",
"type": "string"
},
"user_uuid": {
"description": "UUID",
"example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"maxLength": 36,
"readOnly": true,
"type": "string"
},
"version": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
]
}
}
},
"description": "Test Access policies 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": "Test Access policies response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]