Create Realm Test - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Create Realm Test","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/54f4ba30-7fe2-3433-bbd5-a4d458aee37e","info":{"title":"Cisco Cloud-delivered Firewall Management Center (cdFMC) API","version":"1.15.0","description":"Use the documentation to explore the endpoints the cdFMC has to offer","contact":{"name":"Cisco Firepower TAC","email":"ngfw-support@cisco.com"}},"tags":[{"name":"Analysis"},{"name":"Audit"},{"name":"Backup"},{"name":"Change Management"},{"name":"Chassis"},{"name":"Deployment"},{"name":"Device Clusters"},{"name":"Device Groups"},{"name":"Device HA Pairs"},{"name":"Devices"},{"name":"Health"},{"name":"Integration"},{"name":"Intelligence"},{"name":"License"},{"name":"Network Map"},{"name":"Object"},{"name":"Policy"},{"name":"Policy Assignments"},{"name":"Search"},{"name":"Status"},{"name":"System Configuration"},{"name":"System Information"},{"name":"Templates"},{"name":"Troubleshoot"},{"name":"Updates"},{"name":"Users"}],"openapi":"3.0.1","servers":[{"url":"https://api.us.security.cisco.com/firewall","description":"US"},{"url":"https://api.eu.security.cisco.com/firewall","description":"EU"},{"url":"https://api.apj.security.cisco.com/firewall","description":"APJ"},{"url":"https://api.au.security.cisco.com/firewall","description":"AUS"},{"url":"https://api.in.security.cisco.com/firewall","description":"IN"},{"url":"https://api.int.security.cisco.com/firewall","description":"Staging"},{"url":"https://scale.manage.security.cisco.com/api/rest","description":"Scale"},{"url":"https://ci.manage.security.cisco.com/api/rest","description":"CI"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"deprecated":false,"description":"**Test realm connectivity. _Check the response section for applicable examples (if any)._**","operationId":"createRealmTest","parameters":[{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"}],"requestBody":{"content":{"application/json":{"examples":{"Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/object/operational/testrealms ( Test Azure AD connector properties with client secret value set )":{"value":{"identityConnector":{"clientId":"20354d7a-e4fe-47af-8ff6-187bca92f3f9","clientSecret":"E-c3Q~XUeeeBdkfVBt8QdnS6TVOC2DfDI7OlK","consumerGroupId":"azuread-events-test","eventHubsBroker":"azure-ad-events-934j.servicebus.windows.net:9093","eventHubsConnString":"Endpoint=sb://azure-ad-events-934j.servicebus.windows.net/;SharedAccessKeyName=testad;SharedAccessKey=Fq6YV/ruwOKFYiPVm6PcJKpU3R7a4OEtlfXC7djc0o4=","eventHubsTopic":"test","excludedGroups":["Group_name1","EU_*","*_test"],"includeGroups":[],"tenantId":"8c67caeb-e5f4-4ae0-be47-fbb739939768","type":"AzureADConnector"},"type":"RealmTest"}},"Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/object/operational/testrealms ( Test Azure AD connector properties with client secret value cached )":{"value":{"identityConnector":{"clientId":"20354d7a-e4fe-47af-8ff6-187bca92f3f9","clientSecret":"********","consumerGroupId":"azuread-events-test","eventHubsBroker":"azure-ad-events-934j.servicebus.windows.net:9093","eventHubsConnString":"Endpoint=sb://azure-ad-events-934j.servicebus.windows.net/;SharedAccessKeyName=testad;SharedAccessKey=Fq6YV/ruwOKFYiPVm6PcJKpU3R7a4OEtlfXC7djc0o4=","eventHubsTopic":"test","excludedGroups":["Group_name1","EU_*","*_test"],"id":"azuread-meta-connector.1","includeGroups":[],"tenantId":"8c67caeb-e5f4-4ae0-be47-fbb739939768","type":"AzureADConnector"},"type":"RealmTest"}}},"schema":{"type":"object","description":"Object that can be used to test Realm connection.","properties":{"identityConnector":{"description":"Contains information about the CSDAC connector used by Azure AD","type":"object","properties":{"clientId":{"type":"string"},"clientSecret":{"type":"string"},"consumerGroupId":{"type":"string"},"eventHubsBroker":{"type":"string"},"eventHubsConnString":{"type":"string"},"eventHubsTopic":{"type":"string"},"excludedGroups":{"items":{"type":"string"},"type":"array"},"id":{"type":"string"},"includedGroups":{"items":{"type":"string"},"type":"array"},"tenantId":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/AzureADConnector"},"type":{"description":"Value is 'RealmTest'. Read only fixed value.","type":"string"}},"$$ref":"#/components/schemas/RealmTest"}}},"description":"Input representation of a Realm Test connection object.","required":true},"responses":{"201":{"content":{"application/json":{"examples":{"Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/object/operational/testrealms ( Test Azure AD connector properties with client secret value set )":{"value":{"status":{"message":"OK","status":"STATUS_OK"}}},"Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/object/operational/testrealms ( Test Azure AD connector properties with client secret value cached )":{"value":{"status":{"message":"OK","status":"STATUS_OK"}}}},"schema":{"type":"object","description":"Object that can be used to test Realm connection.","properties":{"identityConnector":{"description":"Contains information about the CSDAC connector used by Azure AD","type":"object","properties":{"clientId":{"type":"string"},"clientSecret":{"type":"string"},"consumerGroupId":{"type":"string"},"eventHubsBroker":{"type":"string"},"eventHubsConnString":{"type":"string"},"eventHubsTopic":{"type":"string"},"excludedGroups":{"items":{"type":"string"},"type":"array"},"id":{"type":"string"},"includedGroups":{"items":{"type":"string"},"type":"array"},"tenantId":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/AzureADConnector"},"type":{"description":"Value is 'RealmTest'. Read only fixed value.","type":"string"}},"$$ref":"#/components/schemas/RealmTest"}}},"description":"Created"},"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"description":"Describes the category of the error thrown.","enum":["FRAMEWORK","OTHER","VALIDATION"],"type":"string"},"messages":{"description":"List of error messages which the response has.","items":{"type":"object","properties":{"bulkPayloadIndex":{"description":"More details about the error.","type":"string"},"code":{"description":"More details about the error.","type":"string"},"description":{"description":"More details about the error.","type":"string"},"details":{"description":"More details about the error.","type":"string"},"errorCode":{"description":"More details about the error.","type":"string"},"location":{"description":"More details about the error.","type":"string"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorMessagesContainer"},"type":"array"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error"}},"tags":["Object"],"__originalOperationId":"createRealmTest","method":"post","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/operational/testrealms"}}