Description

The addUser operation handles configuration related to User model. 
This API call is not allowed on the standby unit in an HA pair.

HTTP request

POST /api/fdm/v6/object/users

Data Parameters

Parameter Required Type Description
name True string A String representing the current user
password False string The current password. It is only used when updating user password
newPassword False string The new password to use. It is only used when updating user password
userPreferences False object An Object representing the timezone, UI theme selected by user
userRole False string The name of the UserRole object that defines the user role (permissions) for this user.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
identitySourceId True string The ID of the IdentitySource the user is associated with.
Field level constraints: cannot be blank or empty, must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
userServiceTypes True [object] Configure the level of access using the service-type. This is an enum value and api consumer can choose from MGMT and RA_VPN
Field level constraints: cannot be blank or empty. (Note: Additional constraints might exist)
type True string A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Example

curl -X POST \
    --header "Accept: application/json" \
    --header "Authorization: Bearer ${ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    -d '{
        "id": "string",
        "identitySourceId": "string",
        "name": "string",
        "newPassword": "string",
        "password": "string",
        "type": "user",
        "userPreferences": {
            "colorTheme": "NORMAL_CISCO_IDENTITY",
            "preferredTimeZone": "string",
            "type": "userpreferences"
        },
        "userRole": "string",
        "userServiceTypes": [
            "RA_VPN"
        ],
        "version": "string"
    }' \
    "https://${HOST}:${PORT}/api/fdm/v6/object/users"
from bravado.requests_client import RequestsClient
from bravado.client import SwaggerClient


def get_client(host, token):
    http_client = RequestsClient()
    http_client.ssl_verify = False
    http_client.set_api_key(
        host,
        "Bearer {}".format(token),
        param_name="Authorization",
        param_in="header"
    )
    return SwaggerClient.from_url(
        "https://{}/apispec/ngfw.json".format(host),
        http_client=http_client,
        config={
            "validate_responses": False,
            "validate_swagger_spec": False
        }
    )


def add_user(client, body):
    return client.User.addUser(
        body=body
    ).response().result


if __name__ == "__main__":
    host = "ftd.example.com"
    token = "access_token"
    client = get_client(host, token)

    body = {'identitySourceId': 'string',
 'name': 'string',
 'newPassword': 'string',
 'password': 'string',
 'type': 'user',
 'userPreferences': {'colorTheme': 'NORMAL_CISCO_IDENTITY',
                     'preferredTimeZone': 'string',
                     'type': 'userpreferences'},
 'userRole': 'string',
 'userServiceTypes': ['RA_VPN']}

    add_user(client, body)