List all authentication rules
Retrieve a list of all authentication rules.
Query Parameters
- limit number
The maximum number of result objects to return per page.
- offset number
The offset of the result entry.
- position string required
Possible values: [
pre
,post
]Default value:
pre
The position of a security rule
- folder string required
Possible values: Value must match regular expression
^[0-9a-zA-Z._-\s]{1,}$
, [Shared
,Mobile Users
,Remote Networks
,Service Connections
,Mobile Users Container
,Mobile Users Explicit Proxy
]The folder on which you want to perform this operation.
- name string
The name of the entry.
- 200
- 400
- 401
- 403
- 404
- default
List of authentication rules
- application/json
- Schema
- Example (from schema)
Schema
data object[]
Array [authentication_enforcement stringcategory string[]description stringdestination string[]destination_hip string[]disabled booleanDefault value:
false
from string[]group_tag stringhip_profiles string[]id stringuuid of the resource
log_authentication_timeout booleanDefault value:
false
log_setting stringname stringnegate_destination booleanDefault value:
false
negate_source booleanDefault value:
false
service string[]source string[]source_hip string[]source_user string[]tag string[]timeout integerPossible values:
>= 1
and<= 1440
to string[]]- limit number
Default value:
200
- offset number
Default value:
0
- total number
{
"data": [
{
"authentication_enforcement": "string",
"category": [
"string"
],
"description": "string",
"destination": [
"string"
],
"destination_hip": [
"string"
],
"disabled": false,
"from": [
"string"
],
"group_tag": "string",
"hip_profiles": [
"string"
],
"id": "abcd-1234",
"log_authentication_timeout": false,
"log_setting": "string",
"name": "string",
"negate_destination": false,
"negate_source": false,
"service": [
"string"
],
"source": [
"string"
],
"source_hip": [
"string"
],
"source_user": [
"string"
],
"tag": [
"string"
],
"timeout": 0,
"to": [
"string"
]
}
],
"limit": 200,
"offset": 0,
"total": 0
}
Bad Request
- application/json
- Schema
- Example (from schema)
- input_format_mismatch
- invalid_query_parameter
- missing_query_parameter
- output_format_mismatch
Schema
_errors object[]
Array [code stringdetails objecthelp stringmessage string]- _request_id string
{
"_errors": [
{
"code": "string",
"details": {},
"help": "string",
"message": "string"
}
],
"_request_id": "string"
}
Input Format Mismatch
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Input Format Mismatch: input-format=json"
}
],
"_request_id": "abcd-1234"
}
Invalid Query Parameter
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Invalid Query Parameter: location=invalid"
}
],
"_request_id": "abcd-1234"
}
Missing Query Parameter
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Missing Query Parameter: name"
}
],
"_request_id": "abcd-1234"
}
Output Format Mismatch
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Output Format Mismatch: output-format=json Accept=xml"
}
],
"_request_id": "abcd-1234"
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- auth_not_authenticated
- invalid_credential
- key_expired
- key_too_long
- need_password_change
Schema
_errors object[]
Array [code stringdetails objecthelp stringmessage string]- _request_id string
{
"_errors": [
{
"code": "string",
"details": {},
"help": "string",
"message": "string"
}
],
"_request_id": "string"
}
Not Authenticated
{
"_errors": [
{
"code": "E016",
"details": {},
"message": "Not Authenticated"
}
],
"_request_id": "abcd-1234"
}
Invalid Credential
{
"_errors": [
{
"code": "E016",
"details": {},
"message": "Invalid Credential"
}
],
"_request_id": "abcd-1234"
}
Key Expired
{
"_errors": [
{
"code": "E016",
"details": {},
"message": "Key Expired"
}
],
"_request_id": "abcd-1234"
}
Key Too Long
{
"_errors": [
{
"code": "E016",
"details": {},
"message": "Key Too Long"
}
],
"_request_id": "abcd-1234"
}
Need Password Change
{
"_errors": [
{
"code": "E016",
"details": {},
"message": "The password needs to be changed."
}
],
"_request_id": "abcd-1234"
}
Forbidden
- application/json
- Schema
- Example (from schema)
- auth_unauthorized
Schema
_errors object[]
Array [code stringdetails objecthelp stringmessage string]- _request_id string
{
"_errors": [
{
"code": "string",
"details": {},
"help": "string",
"message": "string"
}
],
"_request_id": "string"
}
Unauthorized
{
"_errors": [
{
"code": "E007",
"details": {},
"message": "Unauthorized"
}
],
"_request_id": "abcd-1234"
}
Not Found
- application/json
- Schema
- Example (from schema)
- object_not_present
Schema
_errors object[]
Array [code stringdetails objecthelp stringmessage string]- _request_id string
{
"_errors": [
{
"code": "string",
"details": {},
"help": "string",
"message": "string"
}
],
"_request_id": "string"
}
Object Not Present
{
"_errors": [
{
"code": "E005",
"details": {},
"message": "Object Not Present"
}
],
"_request_id": "abcd-1234"
}
General Errors
- application/json
- Schema
- Example (from schema)
- action_not_supported
- bad_xpath
- invalid_command
- malformed_command
- method_not_allowed
- session_timeout
- version_not_supported
Schema
_errors object[]
Array [code stringdetails objecthelp stringmessage string]- _request_id string
{
"_errors": [
{
"code": "string",
"details": {},
"help": "string",
"message": "string"
}
],
"_request_id": "string"
}
Action Not Supported
{
"_errors": [
{
"code": "E012",
"details": {},
"message": "Action Not Supported: move"
}
],
"_request_id": "abcd-1234"
}
Bad XPath
{
"_errors": [
{
"code": "E013",
"details": {},
"message": "Bad XPath"
}
],
"_request_id": "abcd-1234"
}
Invalid Command
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Invalid Command"
}
],
"_request_id": "abcd-1234"
}
Malformed Command
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Malformed Command"
}
],
"_request_id": "abcd-1234"
}
Method Not Supported
{
"_errors": [
{
"code": "E012",
"details": {},
"message": "Method Not Supported"
}
],
"_request_id": "abcd-1234"
}
Session Timeout
{
"_errors": [
{
"code": 4,
"details": {},
"message": "Session Timeout"
}
],
"_request_id": "abcd-1234"
}
Version Not Supported
{
"_errors": [
{
"code": "E012",
"details": {},
"message": "Version Not Supported"
}
],
"_request_id": "abcd-1234"
}