Fortinet Document Library

Version:


Table of Contents

Download PDF
Copy Link

POST

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

Description

realm string No The realm name.
users list No A user list, which includes user IDs and actions.
Example request body:
Input: 
{
    'realm': 'default',
    'users': [{
        'username': 'abc',
        'action': 'delete',
        'id': '12345678-abcd-efgh-1234-xxxxxxxxxxxx',
    },
    {
        'username': 'def',
        'action': 'create',
        'id': '12345678-abcd-efgh-1234-xxxxxxxxxxxx',
    },
    {
        'username': 'ghi',
        'action': 'modify',
        'id': '12345678-abcd-efgh-1234-xxxxxxxxxxxx',
}]
}
Example of successful response body:
Return:
{'task_id': '12345678-abcd-efgh-1234-xxxxxxxxxxxx'}

POST

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

Description

realm string No The realm name.
users list No A user list, which includes user IDs and actions.
Example request body:
Input: 
{
    'realm': 'default',
    'users': [{
        'username': 'abc',
        'action': 'delete',
        'id': '12345678-abcd-efgh-1234-xxxxxxxxxxxx',
    },
    {
        'username': 'def',
        'action': 'create',
        'id': '12345678-abcd-efgh-1234-xxxxxxxxxxxx',
    },
    {
        'username': 'ghi',
        'action': 'modify',
        'id': '12345678-abcd-efgh-1234-xxxxxxxxxxxx',
}]
}
Example of successful response body:
Return:
{'task_id': '12345678-abcd-efgh-1234-xxxxxxxxxxxx'}