Fortinet Document Library

Version:


Table of Contents

Download PDF
Copy Link

GET

URI:
  • /api/v1/token
Input fields:
Field Name Type Required

Description

available

boolean

No

Get all available hard tokens.

soft_token boolean No Get soft tokens.

status

string

No

Applicable status can be one of the following:

  • disable
  • enable
  • transfer
  • others

Note: The status field applies only when you set soft_token=True

user_id

string

No

The user ID.

token_sn

string

No

The serial number of the token.

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

Return:

[{

'customer_id': '123456',

'user_id': None,

'created_at': '2020-02-02T22:22:22',

'sn': 'xxxxxx',

'deleted': 0,

'deleted_at': None,

'updated_at': '2020-02-02T22:22:22',

'username': None,

'realm_id': None

}]

Note

If a web app client uses the API without any input field, the API server will return a list of all hard tokens instead.

GET

URI:
  • /api/v1/token
Input fields:
Field Name Type Required

Description

available

boolean

No

Get all available hard tokens.

soft_token boolean No Get soft tokens.

status

string

No

Applicable status can be one of the following:

  • disable
  • enable
  • transfer
  • others

Note: The status field applies only when you set soft_token=True

user_id

string

No

The user ID.

token_sn

string

No

The serial number of the token.

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

Return:

[{

'customer_id': '123456',

'user_id': None,

'created_at': '2020-02-02T22:22:22',

'sn': 'xxxxxx',

'deleted': 0,

'deleted_at': None,

'updated_at': '2020-02-02T22:22:22',

'username': None,

'realm_id': None

}]

Note

If a web app client uses the API without any input field, the API server will return a list of all hard tokens instead.