Fortinet Document Library

Version:

Version:

Version:


Table of Contents

Administration Guide

Download PDF
Copy Link

Specific group

Retrieve a specific group.

https://<servername>:8443/api/group/{id}

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/1

Example XML format

<groupResult>

<status>success</status>

<errorMessage></errorMessage>

<group>

<daysInactive>0</daysInactive>

<daysValid>0</daysValid>

<description>Administrative users 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>

</groupResult>

Specific group

Retrieve a specific group.

https://<servername>:8443/api/group/{id}

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/1

Example XML format

<groupResult>

<status>success</status>

<errorMessage></errorMessage>

<group>

<daysInactive>0</daysInactive>

<daysValid>0</daysValid>

<description>Administrative users 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>

</groupResult>