Fortinet black logo

REST API Solution Guide

IAM accounts (/iamaccounts/)

URL: https://[server_name]/api/v1/iamaccounts/

This end-point represents IAM account resource.

Supported fields

Field Display name Type Required Other restrictions
name name String Yes Unique.

alias

alias String Yes Unique.

Allowed methods

HTTP method Resource URI Action
GET /api/v1/iamaccounts/ Get all IAM accounts.
GET /api/v1/iamaccounts/[id]/ Get a specific IAM account with ID.

POST

/api/v1/iamaccounts/

Create a new IAM account.

PATCH

/api/v1/iamaccounts/[id]/

Update specified fields for a specific IAM account with ID.

DELETE

/api/v1/iamaccounts/[id]/

Delete a IAM account.

Allowed filters

Field Lookup expressions Values
id exact, in
name exact

alias

exact

URL: https://[server_name]/api/v1/iamaccounts/

This end-point represents IAM account resource.

Supported fields

Field Display name Type Required Other restrictions
name name String Yes Unique.

alias

alias String Yes Unique.

Allowed methods

HTTP method Resource URI Action
GET /api/v1/iamaccounts/ Get all IAM accounts.
GET /api/v1/iamaccounts/[id]/ Get a specific IAM account with ID.

POST

/api/v1/iamaccounts/

Create a new IAM account.

PATCH

/api/v1/iamaccounts/[id]/

Update specified fields for a specific IAM account with ID.

DELETE

/api/v1/iamaccounts/[id]/

Delete a IAM account.

Allowed filters

Field Lookup expressions Values
id exact, in
name exact

alias

exact