Description

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

HTTP request

POST /api/fdm/v6/action/testidentitysource

Data Parameters

Parameter Required Type Description
identitySource True object The ID of a identity source object that defines the identity source to be tested with the specified credentials
Field level constraints: cannot be null. (Note: Additional constraints might exist)
username True string The username (present on the identity source) to be used in issuing an authentication request to the specified identity source
Field level constraints: cannot be null, length must be between 0 and 128 (inclusive). (Note: Additional constraints might exist)
password True string The password for the specified username
Field level constraints: cannot be null. (Note: Additional constraints might exist)
statusCode False integer The status code is '200' only when the identity source responds with an access-accept message to the authentication request
statusMessage False string The status message is 'Successful' only when the identity source responds with an access-accept message to the authentication request
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",
        "identitySource": {
            "id": "string",
            "name": "string",
            "type": "identitysourcebase",
            "version": "string"
        },
        "password": "string",
        "statusCode": 0,
        "statusMessage": "string",
        "type": "TestIdentitySource",
        "username": "string"
    }' \
    "https://${HOST}:${PORT}/api/fdm/v6/action/testidentitysource"
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_test_identity_source(client, body):
    return client.TestIdentitySource.addTestIdentitySource(
        body=body
    ).response().result


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

    body = {'identitySource': {'id': 'string',
                    'name': 'string',
                    'type': 'identitysourcebase',
                    'version': 'string'},
 'password': 'string',
 'statusCode': 0,
 'statusMessage': 'string',
 'type': 'TestIdentitySource',
 'username': 'string'}

    add_test_identity_source(client, body)