View

View information on one or more security profiles.

Tokens

This action requires the following tokens:

  • securityprofile-read

Arguments

Required arguments are marked in bold, and optional arguments are marked in italics.

Argument Type Default Description
securityprofile Hash   If given, limit the output to only the security profile with this hash
searchname String   Only show security profiles having this in their name
limit Integer 20 The maximum number of results to include in the output
offset Integer 0 The number of results to skip when outputting
orderfield String created

Defines the field to order the results by; can be any of the following:

  • created – Sort by when the profile is created
  • modified – Sort by when the profile is last modified
  • name – Sort lexicographically by name
order String asc Sort the results by the field given in orderfield in ascending or descending order, by using ‘asc‘ or ‘desc‘ respectively

Output

This action produces the following extra headers on success, besides the default headers:

Name Type Description
count Integer The total number of results that would be returned when pagination would be disabled

This action produces the following output on success:

An array containing zero or more elements, each one being an object containing the following fields:

Name Type Description
id Hash Security profile ID
name String The name of this security profile
account

The account this profile belongs to

The value of this field is an object containing the following fields:

Name Type Description
id Hash Account ID
name String Account name
datecreated DateTime When this security profile was created
datemodified DateTime When this security profile was last modified
rules

Rules in this profile

The value of this field is an array containing zero or more elements, each one being an object containing the following fields:

Name Type Description
position Integer Position of this rule in the profile
type String Type of the rule. One of: blanket, ip, country, continent, useragent, time, timelocal
ip IP Mask If ruletype is “ip”, IP address (with possible netmask) for this rule
country

If ruletype is “country”, country for this rule

The value of this field is an object containing the following fields:

Name Type Description
code String Code of this contry
name String Name of this contry
continent

Continent of this country

The value of this field is an object containing the following fields:

Name Type Description
code String Code of this continent
name String Name of this continent
continent

If ruletype is “continent”, continent for this rule

The value of this field is an object containing the following fields:

Name Type Description
code String Code of this continent
name String Name of this continent
useragent String If ruletype is “useragent”, user agent for this rule
starttime Time If ruletype is “timeofday” or “timeofdaylocal”, start time for this rule. For “timeofday” it will be returned in the the timezone of the actor. For “timeofdaylocal” it is timezone independent and should be checked with the time in the timezone of the entity accessing the security profile
endtime Time If ruletype is “timeofday” or “timeofdaylocal”, end time for this rule. For “timeofday” it will be returned in the the timezone of the actor. For “timeofdaylocal” it is timezone independent and should be checked with the time in the timezone of the entity accessing the security profile
validfrom DateTime If set, this rule is only valid from (and including) the given date and time
validuntil DateTime If set, this rule is only valid until (and including) the given date and time
verdict String Verdict for this rule, either allow or deny

Errors

This action will always return one of the default status codes.