Get All Secure Client Customization Model - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get All Secure Client Customization 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 Customization objects.**","operationId":"getAllSecureClientCustomizationModel","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"}},{"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/secureclientcustomizations?limit=1 ( Get all paginated secure client customization objects with limit=1 )":{"value":{"items":[{"customizationType":"LANGUAGE_LOCALIZATION","description":"Test-Language-JP","fileName":"language-jp.po","id":"00505681-1EBF-0ed3-0000-523986010132","language":"jp","metadata":{"domain":{"id":"e276abec-e0f2-11e3-8169-6d9ed49b625f","name":"Global","type":"Domain"},"lastUser":{"name":"admin"},"timestamp":1637140503020},"name":"Test-Language-JP","type":"SecureClientCustomization"},{"customizationType":"IMAGE","description":"Test-Icon-About-Desc","fileName":"about.png","id":"00505681-1EBF-0ed3-0000-554050781239","metadata":{"domain":{"id":"e276abec-e0f2-11e3-8169-6d9ed49b625f","name":"Global","type":"Domain"},"lastUser":{"name":"admin"},"timestamp":1637063228973},"name":"Test-Icon-About","operatingSystem":"MAC","type":"SecureClientCustomization"},{"customizationType":"SCRIPT","description":"Test-scipt-mount-drive-desc","fileName":"onConnect_mount_drive.pl","id":"00505681-1EBF-0ed3-0000-474050781256","metadata":{"domain":{"id":"e276abec-e0f2-11e3-8169-6d9ed49b625f","name":"Global","type":"Domain"},"lastUser":{"name":"admin"},"timestamp":1637063228973},"name":"Test-scipt-mount-drive","operatingSystem":"WINDOWS","scriptType":"ON_CONNECT","type":"SecureClientCustomization"}],"links":{"self":"https://\u003cIP:PORT\u003e/api/fmc_config/v1/domain/{domainUUID}/object/secureclientcustomizations?offset=0&limit=1"},"paging":{"count":3,"limit":20,"offset":0,"pages":1}}}},"schema":{"type":"object","properties":{"items":{"type":"array","description":"Secure Client Customization functionality provides a way to modify and customize certain aspects of the Secure Client on the endpoints. Those customizations can be pushed to the endpoints via FTD. Secure Client Customization object is used to upload and maintain the cutsomization files and setting in FMC. Customization objects can then be added to the Remote Access VPN Configuration to push it to the FTD.","properties":{"customizationType":{"description":"Customization Type","enum":["LANGUAGE_LOCALIZATION","IMAGE","SCRIPT","BINARY","CUSTOMIZED_INSTALLER_TRANSFORM","LOCALIZED_INSTALLER_TRANSFORM"],"type":"string"},"description":{"description":"User provided resource description.","type":"string"},"fileName":{"description":"Name of the customization file.","type":"string"},"files":{"items":{"type":"object","properties":{"attrib":{"type":"string"},"id":{"type":"string"},"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"},"name":{"type":"string"},"path":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IFileWrapper"},"type":"array"},"filesMap":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLFilesMap"},"id":{"description":"Unique identifier representing this resource.","type":"string"},"language":{"description":"Language code for the Language localization","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"},"metadata":{"description":"Object representing metadata properties of response object.","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"},"operatingSystem":{"description":"Operating System which is applicable for the selected customization file","enum":["WINDOWS","LINUX","MAC"],"type":"string"},"scriptType":{"description":"Specifies when to execute the scipt","enum":["ON_CONNECT","ON_DISCONNECT"],"type":"string"},"type":{"description":"Type associated with resource: SecureClientCustomizationModel.","type":"string"},"version":{"type":"string"}},"required":["customizationType","fileName"],"$$ref":"#/components/schemas/SecureClientCustomizationModel"},"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/SecureClientCustomizationModelListContainer"}}},"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":"getAllSecureClientCustomizationModel","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/secureclientcustomizations"}}