Fortinet black logo

REST API Solution Guide

Local user group memberships (/localgroup-memberships/)

Local user group memberships (/localgroup-memberships/)

URL:https://[server_name]/api/[api_version]/localgroup-memberships/

This endpoint represents local user group membership resource (relationship between local user and local user group).

Supported fields

Field Description Type Required Read-only Other restrictions
group Group string Yes Local user group URI
user Member of the group string Yes Local user URI
group_name Member of the group string No Yes
username Member username string No Yes

Allowed methods

HTTP method Resource URI Action
GET /api/v1/localgroup-memberships/ Get all local group memberships
GET /api/v1/localgroup-memberships/[id]/ Get a specific local group membership
POST /api/v1/localgroup-memberships/ Create a new local group membership
DELETE /api/v1/localgroup-memberships/[id] Delete a local group membership

Allowed filters

Field Filters Description
group exact, in Accepts group ID (e.g. group=15)
user exact, in Accepts user ID
group_name exact, iexact, contains, icontains, in
username exact, iexact, contains, icontains, in

Local user group memberships (/localgroup-memberships/)

URL:https://[server_name]/api/[api_version]/localgroup-memberships/

This endpoint represents local user group membership resource (relationship between local user and local user group).

Supported fields

Field Description Type Required Read-only Other restrictions
group Group string Yes Local user group URI
user Member of the group string Yes Local user URI
group_name Member of the group string No Yes
username Member username string No Yes

Allowed methods

HTTP method Resource URI Action
GET /api/v1/localgroup-memberships/ Get all local group memberships
GET /api/v1/localgroup-memberships/[id]/ Get a specific local group membership
POST /api/v1/localgroup-memberships/ Create a new local group membership
DELETE /api/v1/localgroup-memberships/[id] Delete a local group membership

Allowed filters

Field Filters Description
group exact, in Accepts group ID (e.g. group=15)
user exact, in Accepts user ID
group_name exact, iexact, contains, icontains, in
username exact, iexact, contains, icontains, in