Description

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

HTTP request

POST /api/fdm/v6/object/realmsequences

Data Parameters

Parameter Required Type Description
name False string A UTF string containing the name for the Realm Sequence.
description False string Description of this RealmSequence object. The string can be up to 200 characters.
Field level constraints: length must be between 0 and 200 (inclusive), must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
realms True [object] A list of Identity Realms
Field level constraints: cannot be blank or empty. (Note: Additional constraints might exist)
Allowed types are: [ActiveDirectoryRealm]
type True string RealmSequence object type

Example

curl -X POST \
    --header "Accept: application/json" \
    --header "Authorization: Bearer ${ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    -d '{
        "description": "string",
        "id": "string",
        "name": "string",
        "realms": [
            {
                "id": "string",
                "name": "string",
                "type": "string",
                "version": "string"
            }
        ],
        "type": "realmsequence",
        "version": "string"
    }' \
    "https://${HOST}:${PORT}/api/fdm/v6/object/realmsequences"
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_realm_sequence(client, body):
    return client.RealmSequence.addRealmSequence(
        body=body
    ).response().result


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

    body = {'description': 'string',
 'name': 'string',
 'realms': [{'id': 'string',
             'name': 'string',
             'type': 'string',
             'version': 'string'}],
 'type': 'realmsequence'}

    add_realm_sequence(client, body)