Fortinet Document Library

Version:


Table of Contents

Download PDF
Copy Link

GET

URI:
  • /api/v1/realm
  • /api/v1/realm/[id]
  • /api/v1/realm?name=***
Input fields:
Field Name Type Required

Description

name string No The realm name.

id

string

No

The realm ID.

deleted

boolean

No

Get the deleted realm record.

Example request body:
Input: 
None
Example of successful response body:

Return:

[{

'description': 'abc',

'deleted_at': None,

'name': 'abc',

'is_default': False,

'id': '12345678-abcd-efgh-1234-xxxxxxxxxxxx'

}]

Note

The response body will be a realm dictionary if the API input field is set to request a specific realm, for example, get realm by its ID. Otherwise, the response body will be a list of realm dictionaries.

GET

URI:
  • /api/v1/realm
  • /api/v1/realm/[id]
  • /api/v1/realm?name=***
Input fields:
Field Name Type Required

Description

name string No The realm name.

id

string

No

The realm ID.

deleted

boolean

No

Get the deleted realm record.

Example request body:
Input: 
None
Example of successful response body:

Return:

[{

'description': 'abc',

'deleted_at': None,

'name': 'abc',

'is_default': False,

'id': '12345678-abcd-efgh-1234-xxxxxxxxxxxx'

}]

Note

The response body will be a realm dictionary if the API input field is set to request a specific realm, for example, get realm by its ID. Otherwise, the response body will be a list of realm dictionaries.