Developer Documentation
ADM NITRO APIs

swg_user_details

June 20, 2023
Contributed by: 
C

Configuration for SWG Transaction Report resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
clean_url_volume <Double> Read-write Clean URL volume.
total_domains <Double> Read-write Domains count.
__count <Double> Read-write count..
url_repu_2_volume <Double> Read-write URL reputation level 2 volume.
total_ssl_intercepts <Double> Read-write Total Intercepts.
risk_score <Double> Read-write Risk Score.
total_domains_prev <Double> Read-write Domains count.
block_count_prev <Double> Read-write URL Block count Prev.
url_repu_level_2_count_prev <Double> Read-write URL reputation level 2 count prev.
total_bytes_in <Double> Read-write Total bytes in.
clean_url_count_prev <Double> Read-write Clean URL count Prev.
url_repu_level_3_count <Double> Read-write URL reputation level 3 count.
total_bytes <Double> Read-write Total bytes.
total_bytes_in_prev <Double> Read-write Total bytes in prev.
user_name_prev <String> Read-write User Name.

Maximum length = 255
total_bytes_prev <Double> Read-write Total bytes prev.
user_name <String> Read-write User Name.

Maximum length = 255
total_requests_prev <Double> Read-write Total transactions prev.
url_repu_4_volume <Double> Read-write URL reputation level 4 volume.
total_ssl_intercepts_prev <Double> Read-write Total Intercepts prev.
url_repu_level_3_count_prev <Double> Read-write URL reputation level 3 count prev.
url_repu_3_volume <Double> Read-write URL reputation level 3 volume.
url_repu_level_4_count <Double> Read-write URL reputation level 4 count.
url_repu_level_1_count <Double> Read-write URL reputation level 1 count.
block_count <Double> Read-write URL Block count.
url_repu_level_2_count <Double> Read-write URL reputation level 2 count.
risk_score_prev <Double> Read-write Risk Score prev.
total_bytes_out_prev <Double> Read-write Total bytes out prev.
url_repu_level_4_count_prev <Double> Read-write URL reputation level 4 count prev.
rpt_sample_time <Double> Read-write Report Sample time..
risky_url_count <Double> Read-write Risky URL count.
domain_name <String> Read-write HTTP Request URL..

Maximum length = 2000
exporter_id <Double> Read-write Exporter ID.
total_bytes_out <Double> Read-write Total bytes out.
clean_url_count <Double> Read-write Clean URL count.
total_requests <Double> Read-write Total transactions.
url_repu_level_0_count <Double> Read-write URL reputation level 0 count.

Operations

(click to see Properties )

  • GET (ALL)

Some options that you can use for each operations:

  • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.

  • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER: <username>

    X-NITRO-PASS: <password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

*Note: * Mandatory parameters are marked in red and placeholder content is marked in green

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/swg_user_details Query-parameters:

asc Use this query-parameter to specify whether the results should be in ascending order or not.

Possible Values: yes, no order_by Use this query-parameter to get the result that is ordered by the given property.

Possible Values: rpt_sample_time group_by Use this query-parameter to get the result that is grouped by according total_not_attempted the given property.

Possible Values: rpt_sample_time HTTPS Method: GET

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "swg_user_details":[{
"clean_url_volume":<Double_value>,
"total_domains":<Double_value>,
"__count":<Double_value>,
"url_repu_2_volume":<Double_value>,
"total_ssl_intercepts":<Double_value>,
"risk_score":<Double_value>,
"total_domains_prev":<Double_value>,
"block_count_prev":<Double_value>,
"url_repu_level_2_count_prev":<Double_value>,
"total_bytes_in":<Double_value>,
"clean_url_count_prev":<Double_value>,
"url_repu_level_3_count":<Double_value>,
"total_bytes":<Double_value>,
"total_bytes_in_prev":<Double_value>,
"user_name_prev":<String_value>,
"total_bytes_prev":<Double_value>,
"user_name":<String_value>,
"total_requests_prev":<Double_value>,
"url_repu_4_volume":<Double_value>,
"total_ssl_intercepts_prev":<Double_value>,
"url_repu_level_3_count_prev":<Double_value>,
"url_repu_3_volume":<Double_value>,
"url_repu_level_4_count":<Double_value>,
"url_repu_level_1_count":<Double_value>,
"block_count":<Double_value>,
"url_repu_level_2_count":<Double_value>,
"risk_score_prev":<Double_value>,
"total_bytes_out_prev":<Double_value>,
"url_repu_level_4_count_prev":<Double_value>,
"rpt_sample_time":<Double_value>,
"risky_url_count":<Double_value>,
"domain_name":<String_value>,
"exporter_id":<Double_value>,
"total_bytes_out":<Double_value>,
"clean_url_count":<Double_value>,
"total_requests":<Double_value>,
"url_repu_level_0_count":<Double_value>}]}

<!--NeedCopy-->
swg_user_details
June 20, 2023
Contributed by: 
C
June 20, 2023
Contributed by: 
C

In this article

Site feedback | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.