Get All Any Connect Custom Attribute Model - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get All Any Connect Custom Attribute 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":"**Get the list of all AnyConnect Custom Attribute objects.**","operationId":"getAllAnyConnectCustomAttributeModel","parameters":[{"description":"To be used in conjunction with \u003ccode\u003e\"unusedOnly:true\"\u003c/code\u003e to search for unused objects and \u003ccode\u003e\"nameOrValue:{nameOrValue}\"\u003c/code\u003e to search for both name and value.","in":"query","name":"filter","required":false,"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"},{"name":"offset","description":"Index of first item to return.","in":"query","required":false,"schema":{"format":"int32","type":"integer"},"$$ref":"#/components/parameters/offset"},{"name":"limit","description":"Number of items to return.","in":"query","required":false,"schema":{"format":"int32","type":"integer"},"$$ref":"#/components/parameters/limit"},{"name":"expanded","description":"If set to true, the GET response displays a list of objects with additional attributes.","in":"query","required":false,"schema":{"type":"boolean"},"$$ref":"#/components/parameters/expanded"}],"responses":{"200":{"content":{"application/json":{"examples":{"Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/anyconnectcustomattributes?limit=1 ( Get all paginated anyconnect custom attribute objects with limit=1 )":{"value":{"items":[{"attributeType":"ALLOW_DEFER_UPDATE","id":"00505681-5111-0ed3-0000-008589934595","links":{"self":"https://\u003cIP:PORT\u003e/api/fmc_config/v1/domain/{domainUUID}/object/anyconnectcustomattributes"},"name":"custAttr1","type":"AnyConnectCustomAttribute"}],"links":{"self":"https://\u003cIP:PORT\u003e/api/fmc_config/v1/domain/{domainUUID}/object/anyconnectcustomattributes?offset=0&limit=1"},"paging":{"count":1,"limit":1,"offset":0,"pages":1}}},"Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/anyconnectcustomattributes?offset=0&limit=25&expanded=true ( Get all paginated anyconnect custom attribute objects with expanded=true )":{"value":{"items":[{"attributeType":"PER_APP_VPN","description":"Per App VPN","id":"00505681-5111-0ed3-0000-012884901891","links":{"self":"https://u35c01p01-vrouter.cisco.com:10421/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/anyconnectcustomattributes/00505681-5111-0ed3-0000-012884901891"},"metadata":{"domain":{"id":"e276abec-e0f2-11e3-8169-6d9ed49b625f","name":"Global","type":"Domain"},"lastUser":{"name":"ma"},"timestamp":1649698834000},"name":"custAttr2","overridable":false,"perAppVpnBase64EncodedValue":"dGVzdA==","type":"AnyConnectCustomAttribute"},{"attributeType":"DYNAMIC_SPLIT_TUNNELING","description":"Dynamic Split Tunneling","dynamicSplitTunnel":{"excludeDomains":["cisco3.com","cisco4.com"],"includeDomains":["cisco1.com","cisco2.com"]},"id":"00505681-5111-0ed3-0000-012884901909","links":{"self":"https://u35c01p01-vrouter.cisco.com:10421/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/anyconnectcustomattributes/00505681-5111-0ed3-0000-012884901909"},"metadata":{"domain":{"id":"e276abec-e0f2-11e3-8169-6d9ed49b625f","name":"Global","type":"Domain"},"lastUser":{"name":"ma"},"timestamp":1649698904000},"name":"custAttr3","overridable":false,"type":"AnyConnectCustomAttribute"},{"attributeType":"ALLOW_DEFER_UPDATE","deferUpdate":{"defaultAction":"DEFER","minimumAnyConnectVersion":"7.2.0","promptType":"NO_PROMPT_AUTO_ACTION"},"description":" Post from rest","id":"00505681-6B90-0ed3-0000-021474836509","links":{"self":"https://u35c01p01-vrouter.cisco.com:10421/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/anyconnectcustomattributes/00505681-6B90-0ed3-0000-021474836509"},"metadata":{"domain":{"id":"e276abec-e0f2-11e3-8169-6d9ed49b625f","name":"Global","type":"Domain"},"lastUser":{"name":"ma"},"timestamp":0},"name":"custAttr2","overridable":false,"type":"AnyConnectCustomAttribute"},{"attributeType":"USER_DEFINED_CUSTOM_ATTR","description":"AnyConnect Custom Attribute User Defined in PUT","id":"00505681-5111-0ed3-0000-064424509586","links":{"self":"https://u35c01p01-vrouter.cisco.com:10421/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/anyconnectcustomattributes/00505681-5111-0ed3-0000-064424509586"},"metadata":{"domain":{"id":"e276abec-e0f2-11e3-8169-6d9ed49b625f","name":"Global","type":"Domain"},"lastUser":{"name":"ma"},"timestamp":0},"name":"custAttr4_put","overridable":false,"type":"AnyConnectCustomAttribute","userDefinedAttribute":{"name":"Test_put","value":"Cisco_put"}}],"links":{"self":"https://\u003cIP:PORT\u003e/api/fmc_config/v1/domain/{domainUUID}/object/anyconnectcustomattributes?offset=0&limit=25&expanded=true"},"paging":{"count":4,"limit":25,"offset":0,"pages":1}}}},"schema":{"type":"object","properties":{"items":{"type":"array","description":"AnyConnect Custom Attribute objects represent custom attribute used in configurations, typically for remote access VPN policies. They can contain custom attribute in AnyConnect.","properties":{"attributeType":{"description":"Type of AnyConnect custom attribute variable.","type":"string"},"deferUpdate":{"description":"Specifies the AnyConnect Defer Update Attribute.","type":"object","properties":{"defaultAction":{"enum":["DEFER","UPDATE"],"type":"string"},"minimumAnyConnectVersion":{"type":"string"},"promptDismissTimeout":{"format":"int32","type":"integer"},"promptType":{"enum":["SHOW_UNTIL_USER_ACTION","SHOW_UNTIL_TIMEOUT","NO_PROMPT_AUTO_ACTION"],"type":"string"}},"$$ref":"#/components/schemas/IAnyConnectDeferUpdateAttribute"},"description":{"description":"User provided resource description.","type":"string"},"dynamicSplitTunnel":{"description":"Specifies the AnyConnect Dynamic Split Tunnel Attribute.","type":"object","properties":{"excludeDomains":{"items":{"type":"string"},"type":"array"},"includeDomains":{"items":{"type":"string"},"type":"array"}},"$$ref":"#/components/schemas/IAnyConnectDynamicSplitTunnelAttribute"},"id":{"description":"Unique identifier representing the AnyConnect Package object.","type":"string"},"links":{"description":"Object containing related links.","type":"object","properties":{"parent":{"type":"string"},"self":{"type":"string"}},"$$ref":"#/components/schemas/Links"},"metadata":{"description":"Object representing metadata attributes for the AnyConnect Package.","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"},"overridable":{"type":"boolean"},"overrideTargetId":{"type":"string"},"overrides":{"type":"object","description":"Defines the override details for this object.","properties":{"parent":{"description":"Link to the parent/global resource which is overriden.","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"},"target":{"description":"The device or the domain target on which this override is enabled.","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"}},"$$ref":"#/components/schemas/IOverride"},"perAppVpnBase64EncodedValue":{"description":"Value of AnyConnect Per App Vpn Attribute.","type":"string"},"type":{"description":"Type associated with resource: AnyConnectPackage.","type":"string"},"userDefinedAttribute":{"description":"Specifies the AnyConnect User Defined Attribute.","type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/IAnyConnectUserDefinedAttribute"},"version":{"type":"string"}},"required":["attributeType"],"$$ref":"#/components/schemas/AnyConnectCustomAttributeModel"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","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"},"paging":{"type":"object","properties":{"count":{"format":"int32","type":"integer"},"limit":{"format":"int32","type":"integer"},"offset":{"format":"int32","type":"integer"},"pages":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/PagingContainer"}},"$$ref":"#/components/schemas/AnyConnectCustomAttributeModelListContainer"}}},"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":"getAllAnyConnectCustomAttributeModel","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/anyconnectcustomattributes"}}