Fortinet black logo

REST API

GET

GET

URI:

  • /api/v1/auth?sn=***

  • /api/v1/auth/[id]

  • api/v1/auth

Input fields:
Field Name Type Required

Description

id

string

No

The auth ID obtained from an auth POST request.

vdom

string

No

The auth client’s vdom.

sn

string

No

The device's serial number
chunksize string No The query size for a batch auth result query. The default chunksize is 500, and the valid range is from 100 to 1000.

Successful response fields:

Field name Type Description
status string

The return status could be "waiting”, “authenticated", or "rejected".

  • If the API request is made with an auth ID, the return status could be "waiting”, “authenticated", or "rejected".

  • If the API request is made with an serial number (client id) for batch auth status checking, the status could be “authenticated" or "rejected". The API request returns an empty list if no push auth response is received.

Response codes:
Code

resppnse content
200 OK Auth info is successfully returned.
400 Bad Request

  • No authid is specified.

  • SN is invalid.

Example request body:
{
   "sn":"abcd"
}
Example of successful response body:
[
   {
      "authid":"12345678-abcd-efgh-1234-xxxxxxxxxxxx",
      "status":"authenticated"
   }
]
Previous
Next

GET

URI:

  • /api/v1/auth?sn=***

  • /api/v1/auth/[id]

  • api/v1/auth

Input fields:
Field Name Type Required

Description

id

string

No

The auth ID obtained from an auth POST request.

vdom

string

No

The auth client’s vdom.

sn

string

No

The device's serial number
chunksize string No The query size for a batch auth result query. The default chunksize is 500, and the valid range is from 100 to 1000.

Successful response fields:

Field name Type Description
status string

The return status could be "waiting”, “authenticated", or "rejected".

  • If the API request is made with an auth ID, the return status could be "waiting”, “authenticated", or "rejected".

  • If the API request is made with an serial number (client id) for batch auth status checking, the status could be “authenticated" or "rejected". The API request returns an empty list if no push auth response is received.

Response codes:
Code

resppnse content
200 OK Auth info is successfully returned.
400 Bad Request

  • No authid is specified.

  • SN is invalid.

Example request body:
{
   "sn":"abcd"
}
Example of successful response body:
[
   {
      "authid":"12345678-abcd-efgh-1234-xxxxxxxxxxxx",
      "status":"authenticated"
   }
]
Previous
Next