Update Radius Server Group Model - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Update Radius Server Group Model","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":"**Modify the Radius server group associated with the specified ID. _Check the response section for applicable examples (if any)._**","operationId":"updateRadiusServerGroupModel","parameters":[{"description":"Unique identifier of the Radius server group.","in":"path","name":"objectId","required":true,"schema":{"type":"string"}},{"description":"UUID of the ticket for tracking the configuration changes.","in":"header","name":"ticket-id","required":false,"schema":{"type":"string"}},{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"}],"requestBody":{"content":{"application/json":{"examples":{"Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/radiusservergroups/RadiusServerGroupUUID ( Put operation for Radius Server Group )":{"value":{"description":"Radius-Server-1 desc","dynamicAuthorizationPort":1800,"enableAuthorizeOnly":true,"enableDynamicAuthorization":true,"enableInterimAccountUpdate":true,"enableMergeDacl":true,"groupAccountingMode":"MULTIPLE","id":"RadiusServerGroupUUID","interimAccountUpdateInterval":110,"mergeDaclPlacementOrder":"MERGE_DACL_AFTER_AV_PAIR_ACL","name":"Radius-Server-1","radiusServers":[{"host":"string","interface":{"id":"InterfaceUUID","name":"String","type":"SecurityZone"},"redirectACL":{"id":"ExtendedAccessListUUID","name":"string","type":"ExtendedAccessList"},"serverAccountingPort":1813,"serverAuthenticationPort":1812,"serverSecretKey":"****","timeout":110,"useRoutingToSelectInterface":true}],"realm":{"id":"RealmUUID","name":"Realm","type":"Realm"},"retryInterval":4,"type":"RadiusServerGroup"}},"Example 2 : PUT /fmc_config/v1/domain/DomainUUID/object/radiusservergroups/RadiusServerGroupUUID ( Put operation for Radius Server Group )":{"value":{"description":"Radius-Server-1 desc","enableAuthorizeOnly":false,"enableDynamicAuthorization":false,"enableInterimAccountUpdate":false,"enableMergeDacl":true,"groupAccountingMode":"MULTIPLE","id":"RadiusServerGroupUUID","interimAccountUpdateInterval":110,"mergeDaclPlacementOrder":"MERGE_DACL_AFTER_AV_PAIR_ACL","name":"Radius-Server-2","radiusServers":[{"host":"string","serverAccountingPort":1813,"serverAuthenticationPort":1812,"serverSecretKey":"****","timeout":110,"useRoutingToSelectInterface":true}],"realm":{"id":"RealmUUID","name":"Realm","type":"Realm"},"retryInterval":4,"type":"RadiusServerGroup"}}},"schema":{"type":"object","description":"Radius Server Group objects contain one or more references to Radius servers. These servers are used to authenticate users logging in through Remote Access VPN connections.","properties":{"description":{"description":"User provided resource description.","type":"string"},"dynamicAuthorizationPort":{"description":"ASA will listen to the port for the CoA policy updates from ISE. Default is 1700, the range is 1024 to 65535.","format":"int32","type":"integer"},"enableAuthorizeOnly":{"description":"ISE server is used only for authorization when certificate authentication is enabled","type":"boolean"},"enableDynamicAuthorization":{"description":"Enable the Radius Dynamic Authorization (ISE Change of Authorization, CoA) services for the AAA server group","type":"boolean"},"enableInterimAccountUpdate":{"description":"Enable the periodic generation of Radius interim-accounting-update messages","type":"boolean"},"enableMergeDacl":{"description":"Enable merge of downloadable ACL with the ACL received in the Cisco AV pair from a RADIUS Server.","type":"boolean"},"groupAccountingMode":{"description":"Indicates whether accounting messages are sent to a single server (single mode) or sent to all servers in the group (simultaneous mode)","enum":["SINGLE","MULTIPLE"],"type":"string"},"id":{"description":"Unique identifier representing the CertificateMap object.","type":"string"},"interimAccountUpdateInterval":{"description":"Interval at which the accounting records are transmitted for every VPN session to the server group. Default 24 hours, Range 1-120 hours","format":"int32","type":"integer"},"links":{"description":"Object containing related links.","type":"object","properties":{"parent":{"type":"string"},"self":{"type":"string"}},"$$ref":"#/components/schemas/Links"},"mergeDaclPlacementOrder":{"description":"Specifies whether the downloadable ACL entries should be placed after the Cisco AV pair entries or before.","enum":["MERGE_DACL_BEFORE_AV_PAIR_ACL","MERGE_DACL_AFTER_AV_PAIR_ACL"],"type":"string"},"metadata":{"description":"Object representing metadata attributes for the CertificateMap.","type":"object","properties":{"domain":{"description":"Defines the domains this instance belongs to (if applicable).","type":"object","properties":{"id":{"description":"Unique UUID of this domain","type":"string"},"links":{"description":"Links to the domain resource URLs.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"Name of the domain.","type":"string"},"type":{"description":"Domain type definition (fixed).","type":"string"},"uuid":{"type":"string"}},"$$ref":"#/components/schemas/Domain"},"isLocked":{"type":"boolean"},"lastUser":{"description":"The last user who modified this instance.","type":"object","properties":{"id":{"description":"The unique UUID of the user","type":"string"},"links":{"description":"Contains the self referencing links to this resource","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"Name of the user.","type":"string"},"type":{"description":"The user type (fixed).","type":"string"}},"$$ref":"#/components/schemas/MetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"description":"Details regarding the read only status of this instance","type":"object","properties":{"reason":{"description":"Reason the resource is read only - SYSTEM (if it is system defined), RBAC (if user RBAC permissions make it read only) or DOMAIN (if resource is read only in current domain).","enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"description":"True if this resource us read only and false otherwise.","type":"boolean"}},"$$ref":"#/components/schemas/ReadOnly"},"timestamp":{"description":"The last updated timestamp.","format":"int32","type":"integer"}},"$$ref":"#/components/schemas/Metadata"},"name":{"description":"User provided resource name","type":"string"},"radiusServers":{"items":{"type":"object","description":"Radius servers are used to authenticate users logging in through Remote Access VPN connections.","properties":{"accountingPort":{"format":"int32","type":"integer"},"authenticationPort":{"format":"int32","type":"integer"},"enableMessageAuthenticator":{"type":"boolean"},"host":{"description":"IP Address or the FQDN Name of the Radius Server","type":"string"},"interface":{"description":"Interface to connect the Radius Server.","type":"object","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"redirectACL":{"description":"Acl that needed to be applied for dynamic authorization.","type":"object","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"secretKey":{"type":"string"},"timeout":{"description":"Time in seconds that FTD waits for Radius Server's response.","format":"int32","type":"integer"},"useRoutingToSelectInterface":{"description":"Specify the routing table or the interface to be used to connect the radius server","type":"boolean"}},"required":["authenticationPort","host","secretKey"],"$$ref":"#/components/schemas/IRadiusServers"},"type":"array"},"realm":{"type":"object","description":"Contains reference information.","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"retryInterval":{"description":"Specifies the retry interval (1-10 seconds) for the request","format":"int32","type":"integer"},"type":{"description":"Type associated with resource: RadiusServerGroup.","type":"string"},"version":{"type":"string"}},"required":["radiusServers","retryInterval"],"$$ref":"#/components/schemas/RadiusServerGroupModel"}}},"description":"Input representation of Radius Server Group object.","required":true},"responses":{"200":{"content":{"application/json":{"examples":{"Example 1 : PUT /fmc_config/v1/domain/DomainUUID/object/radiusservergroups/RadiusServerGroupUUID ( Put operation for Radius Server Group )":{"value":{"description":"Radius-Server-1 desc","dynamicAuthorizationPort":1800,"enableAuthorizeOnly":true,"enableDynamicAuthorization":true,"enableInterimAccountUpdate":true,"enableMergeDacl":true,"groupAccountingMode":"MULTIPLE","interimAccountUpdateInterval":110,"links":{"parent":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/DomainUUID/object/radiusservergroups","self":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/DomainUUID/object/radiusservergroups/RadiusServerGroupUUID"},"mergeDaclPlacementOrder":"MERGE_DACL_AFTER_AV_PAIR_ACL","metadata":{"domain":{"id":"DomainUUID","name":"Global"},"lastUser":{"name":"rest"},"timestamp":1524129145233},"name":"Radius-Server-1","radiusServers":[{"host":"string","interface":{"id":"InterfaceUUID","name":"String","type":"SecurityZone"},"redirectACL":{"id":"ExtendedAccessListUUID","name":"string","type":"ExtendedAccessList"},"serverAccountingPort":1813,"serverAuthenticationPort":1812,"serverSecretKey":"****","timeout":110,"useRoutingToSelectInterface":true}],"realm":{"id":"RealmUUID","name":"Realm","type":"Realm"},"retryInterval":4,"type":"RadiusServerGroup"}},"Example 2 : PUT /fmc_config/v1/domain/DomainUUID/object/radiusservergroups/RadiusServerGroupUUID ( Put operation for Radius Server Group )":{"value":{"description":"Radius-Server-1 desc","enableAuthorizeOnly":false,"enableDynamicAuthorization":false,"enableInterimAccountUpdate":false,"enableMergeDacl":true,"groupAccountingMode":"MULTIPLE","interimAccountUpdateInterval":110,"links":{"parent":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/DomainUUID/object/radiusservergroups","self":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/DomainUUID/object/radiusservergroups/RadiusServerGroupUUID"},"mergeDaclPlacementOrder":"MERGE_DACL_AFTER_AV_PAIR_ACL","metadata":{"domain":{"id":"DomainUUID","name":"Global"},"lastUser":{"name":"rest"},"timestamp":1524129145233},"name":"Radius-Server-1","radiusServers":[{"host":"string","serverAccountingPort":1813,"serverAuthenticationPort":1812,"serverSecretKey":"****","timeout":110,"useRoutingToSelectInterface":true}],"realm":{"id":"RealmUUID","name":"Realm","type":"Realm"},"retryInterval":4,"type":"RadiusServerGroup"}}},"schema":{"type":"object","description":"Radius Server Group objects contain one or more references to Radius servers. These servers are used to authenticate users logging in through Remote Access VPN connections.","properties":{"description":{"description":"User provided resource description.","type":"string"},"dynamicAuthorizationPort":{"description":"ASA will listen to the port for the CoA policy updates from ISE. Default is 1700, the range is 1024 to 65535.","format":"int32","type":"integer"},"enableAuthorizeOnly":{"description":"ISE server is used only for authorization when certificate authentication is enabled","type":"boolean"},"enableDynamicAuthorization":{"description":"Enable the Radius Dynamic Authorization (ISE Change of Authorization, CoA) services for the AAA server group","type":"boolean"},"enableInterimAccountUpdate":{"description":"Enable the periodic generation of Radius interim-accounting-update messages","type":"boolean"},"enableMergeDacl":{"description":"Enable merge of downloadable ACL with the ACL received in the Cisco AV pair from a RADIUS Server.","type":"boolean"},"groupAccountingMode":{"description":"Indicates whether accounting messages are sent to a single server (single mode) or sent to all servers in the group (simultaneous mode)","enum":["SINGLE","MULTIPLE"],"type":"string"},"id":{"description":"Unique identifier representing the CertificateMap object.","type":"string"},"interimAccountUpdateInterval":{"description":"Interval at which the accounting records are transmitted for every VPN session to the server group. Default 24 hours, Range 1-120 hours","format":"int32","type":"integer"},"links":{"description":"Object containing related links.","type":"object","properties":{"parent":{"type":"string"},"self":{"type":"string"}},"$$ref":"#/components/schemas/Links"},"mergeDaclPlacementOrder":{"description":"Specifies whether the downloadable ACL entries should be placed after the Cisco AV pair entries or before.","enum":["MERGE_DACL_BEFORE_AV_PAIR_ACL","MERGE_DACL_AFTER_AV_PAIR_ACL"],"type":"string"},"metadata":{"description":"Object representing metadata attributes for the CertificateMap.","type":"object","properties":{"domain":{"description":"Defines the domains this instance belongs to (if applicable).","type":"object","properties":{"id":{"description":"Unique UUID of this domain","type":"string"},"links":{"description":"Links to the domain resource URLs.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"Name of the domain.","type":"string"},"type":{"description":"Domain type definition (fixed).","type":"string"},"uuid":{"type":"string"}},"$$ref":"#/components/schemas/Domain"},"isLocked":{"type":"boolean"},"lastUser":{"description":"The last user who modified this instance.","type":"object","properties":{"id":{"description":"The unique UUID of the user","type":"string"},"links":{"description":"Contains the self referencing links to this resource","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"Name of the user.","type":"string"},"type":{"description":"The user type (fixed).","type":"string"}},"$$ref":"#/components/schemas/MetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"description":"Details regarding the read only status of this instance","type":"object","properties":{"reason":{"description":"Reason the resource is read only - SYSTEM (if it is system defined), RBAC (if user RBAC permissions make it read only) or DOMAIN (if resource is read only in current domain).","enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"description":"True if this resource us read only and false otherwise.","type":"boolean"}},"$$ref":"#/components/schemas/ReadOnly"},"timestamp":{"description":"The last updated timestamp.","format":"int32","type":"integer"}},"$$ref":"#/components/schemas/Metadata"},"name":{"description":"User provided resource name","type":"string"},"radiusServers":{"items":{"type":"object","description":"Radius servers are used to authenticate users logging in through Remote Access VPN connections.","properties":{"accountingPort":{"format":"int32","type":"integer"},"authenticationPort":{"format":"int32","type":"integer"},"enableMessageAuthenticator":{"type":"boolean"},"host":{"description":"IP Address or the FQDN Name of the Radius Server","type":"string"},"interface":{"description":"Interface to connect the Radius Server.","type":"object","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"redirectACL":{"description":"Acl that needed to be applied for dynamic authorization.","type":"object","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"secretKey":{"type":"string"},"timeout":{"description":"Time in seconds that FTD waits for Radius Server's response.","format":"int32","type":"integer"},"useRoutingToSelectInterface":{"description":"Specify the routing table or the interface to be used to connect the radius server","type":"boolean"}},"required":["authenticationPort","host","secretKey"],"$$ref":"#/components/schemas/IRadiusServers"},"type":"array"},"realm":{"type":"object","description":"Contains reference information.","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"retryInterval":{"description":"Specifies the retry interval (1-10 seconds) for the request","format":"int32","type":"integer"},"type":{"description":"Type associated with resource: RadiusServerGroup.","type":"string"},"version":{"type":"string"}},"required":["radiusServers","retryInterval"],"$$ref":"#/components/schemas/RadiusServerGroupModel"}}},"description":"OK"},"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":"updateRadiusServerGroupModel","method":"put","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/radiusservergroups/{objectId}"}}