Fortinet black logo

Administration Guide

Group

Copy Link
Copy Doc ID 8bec453a-b242-11e9-a989-00505692583a:751034
Download PDF

Retrieve groups.

https://<servername>:8443/api/group

https://<servername>:8443/api/group?name={name}

Return value

Type

Description

id

Integer

name

String

daysInactive

Integer

daysValid

Integer

description

String

owner

String

type

String

members

List of group members with record id and name

childGroups

List of groups that are members of this group with record id and name

Example request

curl -k -u '<username>:<password>' -H "accept: application/xml" -X GET https://<servername>:8443/api/group?name=All%20Management%20Group

Example XML format

<groupSearchResult>

<status>success</status>

<limit>0</limit>

<nextOffset>31</nextOffset>

<offset>0</offset>

<total>31</total>

<groups>

<group>

<daysInactive>0</daysInactive>

<daysValid>0</daysValid>

<description>Administrators with all management access rights.</ description>

<id>1</id>

<members>

<member><id>1</id><name>root</name></member>

<member><id>6</id><name>helpdesk, helpdesk</name></member>

<member><id>22</id><name>admin, </name></member>

<member><id>21</id><name>operator, operator</name></member>

<member><id>33</id><name>Howard, Moe</name></member>

</members>

<childGroups></childGroups>

<name>All Management Group</name>

<owner>System</owner>

<type>Administrator</type>

</group>

</groups>

</groupSearchResult>

Retrieve groups.

https://<servername>:8443/api/group

https://<servername>:8443/api/group?name={name}

Return value

Type

Description

id

Integer

name

String

daysInactive

Integer

daysValid

Integer

description

String

owner

String

type

String

members

List of group members with record id and name

childGroups

List of groups that are members of this group with record id and name

Example request

curl -k -u '<username>:<password>' -H "accept: application/xml" -X GET https://<servername>:8443/api/group?name=All%20Management%20Group

Example XML format

<groupSearchResult>

<status>success</status>

<limit>0</limit>

<nextOffset>31</nextOffset>

<offset>0</offset>

<total>31</total>

<groups>

<group>

<daysInactive>0</daysInactive>

<daysValid>0</daysValid>

<description>Administrators with all management access rights.</ description>

<id>1</id>

<members>

<member><id>1</id><name>root</name></member>

<member><id>6</id><name>helpdesk, helpdesk</name></member>

<member><id>22</id><name>admin, </name></member>

<member><id>21</id><name>operator, operator</name></member>

<member><id>33</id><name>Howard, Moe</name></member>

</members>

<childGroups></childGroups>

<name>All Management Group</name>

<owner>System</owner>

<type>Administrator</type>

</group>

</groups>

</groupSearchResult>