mpsgroup
Configuration for System Groups resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| allow_application_only | <Boolean> | Read-write | Checks if only application centic page is needed. |
| session_timeout | <Integer> | Read-write | Session timeout for the Group. |
| permission | <String> | Read-write | Permission for the group (admin/read-only). Minimum length = 1 Maximum length = 128 |
| name | <String> | Read-write | Group Name. Minimum length = 1 Maximum length = 64 |
| session_timeout_unit | <String> | Read-write | Session timeout unit for the Group. |
| description | <String> | Read-write | Description of Group. Minimum length = 1 Maximum length = 1024 |
| assign_all_apps | <Boolean> | Read-write | Assign All Applications (YES|NO). |
| enable_session_timeout | <Boolean> | Read-write | Enables session timeout for group. |
| tenant_id | <String> | Read-write | Id of the tenant. Minimum length = 1 Maximum length = 128 |
| assign_all_devices | <Boolean> | Read-write | Assign All Instances (YES|NO). |
| id | <String> | Read-write | Id is system generated key for all the system groups. |
| role | <String> | Read-write | Role (admin|nonadmin). |
| roles | <String[]> | Read-write | Roles assigned to the group. |
| application_names_without_regex | <String[]> | Read-write | selected application names that are part of this group. |
| standalone_instances_id | <String[]> | Read-write | Stand alone instances belong to this groupp. |
| users | <String[]> | Read-write | Users belong to the group. |
| application_names | <String[]> | Read-write | All Application names that are part of this group.This includes selected appnames as well as applications which are result of defined regex. |
| application_names_with_regex | <String[]> | Read-write | Application names defined with regex that are part of this group. |
Operations
(click to see Properties)
ADD| DELETE| GET (ALL)| GET| UPDATE
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>.
add
URL: https://<MGMT-IP>/nitro/v1/config/mpsgroup?onerror=<String_value>
HTTP Method: null
Request Payload:
{mpsgroup: {
<b>"permission":<String_value></b>,
<b>"name":<String_value></b>,
"session_timeout":<Integer_value>,
"session_timeout_unit":<String_value>,
"assign_all_apps":<Boolean_value>,
"enable_session_timeout":<Boolean_value>,
"id":<String_value>,
"application_names_without_regex":<String_value[]>,
"roles":<String_value[]>,
"allow_application_only":<Boolean_value>,
"description":<String_value>,
"application_names":<String_value[]>,
"application_names_with_regex":<String_value[]>,
"role":<String_value>,
"standalone_instances_id":<String_value[]>,
"users":<String_value[]>,
"tenant_id":<String_value>,
"assign_all_devices":<Boolean_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mpsgroup":[{
"allow_application_only":<Boolean_value>,
"session_timeout":<Integer_value>,
"permission":<String_value>,
"name":<String_value>,
"session_timeout_unit":<String_value>,
"description":<String_value>,
"assign_all_apps":<Boolean_value>,
"enable_session_timeout":<Boolean_value>,
"authscope_props":[{
"parent_name":<String_value>,
"propname":<String_value>,
"rbaoperator":<String_value>,
"id":<String_value>,
"parent_id":<String_value>,
"propvalue":<String_value>
"propvalues":<String_value>}],
"tenant_id":<String_value>,
"assign_all_devices":<Boolean_value>,
"id":<String_value>,
"role":<String_value>,
"roles":<String_value>,
"application_names_without_regex":<String_value>,
"tenant_name":<String_value>,
"standalone_instances_id":<String_value>,
"users":<String_value>,
"application_names":<String_value>,
"application_list":[{
"parent_name":<String_value>,
"app_state":<String_value>,
"parent_id":<String_value>,
"device_ip_address":<String_value>,
"app_protocol":<String_value>,
"appname":<String_value>,
"app_ip_address":<String_value>,
"entity_id":<String_value>,
"app_type":<String_value>,
"id":<String_value>,
"config_path":<String_value>}],
"application_names_with_regex":<String_value>}]}
delete
URL: https://<MGMT-IP>/nitro/v1/config/mpsgroup/id_value<String>
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value> }
get (all)
URL: https://<MGMT-IP>/nitro/v1/config/mpsgroup
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mpsgroup":[{
"allow_application_only":<Boolean_value>,
"session_timeout":<Integer_value>,
"permission":<String_value>,
"name":<String_value>,
"session_timeout_unit":<String_value>,
"description":<String_value>,
"assign_all_apps":<Boolean_value>,
"enable_session_timeout":<Boolean_value>,
"authscope_props":[{
"parent_name":<String_value>,
"propname":<String_value>,
"rbaoperator":<String_value>,
"id":<String_value>,
"parent_id":<String_value>,
"propvalue":<String_value>
"propvalues":<String_value>}],
"tenant_id":<String_value>,
"assign_all_devices":<Boolean_value>,
"id":<String_value>,
"role":<String_value>,
"roles":<String_value>,
"application_names_without_regex":<String_value>,
"tenant_name":<String_value>,
"standalone_instances_id":<String_value>,
"users":<String_value>,
"application_names":<String_value>,
"application_list":[{
"parent_name":<String_value>,
"app_state":<String_value>,
"parent_id":<String_value>,
"device_ip_address":<String_value>,
"app_protocol":<String_value>,
"appname":<String_value>,
"app_ip_address":<String_value>,
"entity_id":<String_value>,
"app_type":<String_value>,
"id":<String_value>,
"config_path":<String_value>}],
"application_names_with_regex":<String_value>}]}
get
URL: https://<MGMT-IP>/nitro/v1/config/mpsgroup/id_value<String>
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mpsgroup":[{
"allow_application_only":<Boolean_value>,
"session_timeout":<Integer_value>,
"permission":<String_value>,
"name":<String_value>,
"session_timeout_unit":<String_value>,
"description":<String_value>,
"assign_all_apps":<Boolean_value>,
"enable_session_timeout":<Boolean_value>,
"authscope_props":[{
"parent_name":<String_value>,
"propname":<String_value>,
"rbaoperator":<String_value>,
"id":<String_value>,
"parent_id":<String_value>,
"propvalue":<String_value>
"propvalues":<String_value>}],
"tenant_id":<String_value>,
"assign_all_devices":<Boolean_value>,
"id":<String_value>,
"role":<String_value>,
"roles":<String_value>,
"application_names_without_regex":<String_value>,
"tenant_name":<String_value>,
"standalone_instances_id":<String_value>,
"users":<String_value>,
"application_names":<String_value>,
"application_list":[{
"parent_name":<String_value>,
"app_state":<String_value>,
"parent_id":<String_value>,
"device_ip_address":<String_value>,
"app_protocol":<String_value>,
"appname":<String_value>,
"app_ip_address":<String_value>,
"entity_id":<String_value>,
"app_type":<String_value>,
"id":<String_value>,
"config_path":<String_value>}],
"application_names_with_regex":<String_value>}]}
update
URL: https://<MGMT-IP>/nitro/v1/config/mpsgroup/id_value<String>
HTTP Method: null
Request Payload:
{mpsgroup:{
<b>"id":<String_value></b>,
"session_timeout":<Integer_value>,
"session_timeout_unit":<String_value>,
"assign_all_apps":<Boolean_value>,
"enable_session_timeout":<Boolean_value>,
"application_names_without_regex":<String_value[]>,
"roles":<String_value[]>,
"allow_application_only":<Boolean_value>,
"name":<String_value>,
"permission":<String_value>,
"description":<String_value>,
"application_names":<String_value[]>,
"application_names_with_regex":<String_value[]>,
"role":<String_value>,
"standalone_instances_id":<String_value[]>,
"users":<String_value[]>,
"tenant_id":<String_value>,
"assign_all_devices":<Boolean_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mpsgroup":[{
"allow_application_only":<Boolean_value>,
"session_timeout":<Integer_value>,
"permission":<String_value>,
"name":<String_value>,
"session_timeout_unit":<String_value>,
"description":<String_value>,
"assign_all_apps":<Boolean_value>,
"enable_session_timeout":<Boolean_value>,
"authscope_props":[{
"parent_name":<String_value>,
"propname":<String_value>,
"rbaoperator":<String_value>,
"id":<String_value>,
"parent_id":<String_value>,
"propvalue":<String_value>
"propvalues":<String_value>}],
"tenant_id":<String_value>,
"assign_all_devices":<Boolean_value>,
"id":<String_value>,
"role":<String_value>,
"roles":<String_value>,
"application_names_without_regex":<String_value>,
"tenant_name":<String_value>,
"standalone_instances_id":<String_value>,
"users":<String_value>,
"application_names":<String_value>,
"application_list":[{
"parent_name":<String_value>,
"app_state":<String_value>,
"parent_id":<String_value>,
"device_ip_address":<String_value>,
"app_protocol":<String_value>,
"appname":<String_value>,
"app_ip_address":<String_value>,
"entity_id":<String_value>,
"app_type":<String_value>,
"id":<String_value>,
"config_path":<String_value>}],
"application_names_with_regex":<String_value>}]}