Create Multiple Key Chain Object - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Create Multiple Key Chain Object","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":"**Create a keychain object. _Check the response section for applicable examples (if any)._**","operationId":"createMultipleKeyChainObject","parameters":[{"description":"Boolean indicating whether this is a bulk operation.","in":"query","name":"bulk","required":false,"schema":{"type":"boolean"}},{"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 : POST /api/fmc_config/v1/domain/DomainUUID/object/keychain ( POST method for Key Chain Object )":{"value":{"keys":[{"acceptLifeTime":{"endLifeTimeValue":"2018-08-27T12:14:23","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-25T12:14:23"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"keyString"},"keyId":2,"sendLifeTime":{"endLifeTimeValue":"234","endLifetimeType":"DURATION","startLifeTimeValue":"2018-08-25T12:14:23"}},{"acceptLifeTime":{"endLifeTimeValue":"2018-08-27T12:14:23","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-25T12:14:23"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"keyString"},"keyId":24,"sendLifeTime":{"endLifetimeType":"INFINITE","startLifeTimeValue":"2018-08-25T12:14:23"}},{"acceptLifeTime":{"endLifeTimeValue":"2018-08-27T12:14:23","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-25T12:14:23"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"keyString"},"keyId":3,"sendLifeTime":{"endLifeTimeValue":"2018-08-27T12:14:23","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-25T12:14:23"}},{"acceptLifeTime":{"endLifeTimeValue":"2018-08-27T12:14:23","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-25T12:14:23"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"keyString"},"keyId":34,"sendLifeTime":{"endLifeTimeValue":"2018-08-27T12:14:23","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-25T12:14:23"}},{"acceptLifeTime":{"endLifeTimeValue":"2018-08-27T12:14:23","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-25T12:14:23"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"keyString"},"keyId":4,"sendLifeTime":{"endLifeTimeValue":"2018-08-27T12:14:23","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-25T12:14:23"}},{"acceptLifeTime":{"endLifeTimeValue":"2018-08-27T12:14:23","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-25T12:14:23"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"keyString"},"keyId":5,"sendLifeTime":{"endLifeTimeValue":"2018-08-27T12:14:23","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-25T12:14:23"}}],"name":"KeyChainObjectName1","overridable":false,"type":"KeyChainObject"}},"Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/object/keychain?bulk=true ( POST method for Key Chain Bulk Object )":{"value":[{"description":"desciption","keys":[{"acceptLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"plaintext"},"keyId":1,"sendLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"}}],"name":"KeyChain1","type":"KeyChainObject"},{"description":"desciption","keys":[{"acceptLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"plaintext"},"keyId":1,"sendLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"}}],"name":"keychain2","type":"KeyChainObject"}]},"Example 3 : POST /api/fmc_config/v1/domain/DomainUUID/object/keychain?bulk=true ( POST method for Key Chain Object with Bulk Override )":{"value":[{"description":"override_keychain_rest_5","keys":[{"acceptLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"plaintext"},"keyId":1,"sendLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"}},{"acceptLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"plaintext"},"keyId":2,"sendLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"}},{"acceptLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"plaintext"},"keyId":3,"sendLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"}}],"name":"parent_keychain_rest_6","overridable":true,"overrides":{"parent":{"id":"KeyChainUUID","type":"KeyChainObject"},"target":{"id":"DeviceUUID","name":"DeviceName","type":"Device"}},"type":"KeyChainObject"},{"description":"override_keychain_rest_6","keys":[{"acceptLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"plaintext"},"keyId":1,"sendLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"}},{"acceptLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"plaintext"},"keyId":2,"sendLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"}},{"acceptLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"plaintext"},"keyId":3,"sendLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"}}],"name":"parent_keychain_rest_6","overridable":true,"overrides":{"parent":{"id":"KeyChainUUID","type":"KeyChainObject"},"target":{"id":"DomainUUID","name":"DomainName","type":"Domain"}},"type":"KeyChainObject"}]},"Example 4 : POST /api/fmc_config/v1/domain/DomainUUID/object/keychain ( POST method for Key Chain override Object with device )":{"value":{"description":"description for keychain object","keys":[{"acceptLifeTime":{"endLifeTimeValue":"2018-08-27T12:14:23","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-25T12:14:23"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"keyString"},"keyId":2,"sendLifeTime":{"endLifeTimeValue":"234","endLifetimeType":"DURATION","startLifeTimeValue":"2018-08-25T12:14:23"}},{"acceptLifeTime":{"endLifeTimeValue":"2018-08-27T12:14:23","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-25T12:14:23"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"keyString"},"keyId":24,"sendLifeTime":{"endLifetimeType":"INFINITE","startLifeTimeValue":"2018-08-25T12:14:23"}}],"name":"KeyChainObjectName1","overridable":true,"overrides":{"parent":{"id":"KeyChainUUID","type":"KeyChainObject"},"target":{"id":"deviceUUID","name":"10.10.9.20","type":"Device"}},"type":"KeyChainObject"}},"Example 5 : POST /api/fmc_config/v1/domain/DomainUUID/object/keychain ( POST method for Key Chain Object override with domain )":{"value":{"description":"description for keychain object","keys":[{"acceptLifeTime":{"endLifeTimeValue":"2018-08-27T12:14:23","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-25T12:14:23"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"keyString"},"keyId":2,"sendLifeTime":{"endLifeTimeValue":"234","endLifetimeType":"DURATION","startLifeTimeValue":"2018-08-25T12:14:23"}},{"acceptLifeTime":{"endLifeTimeValue":"2018-08-27T12:14:23","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-25T12:14:23"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"keyString"},"keyId":24,"sendLifeTime":{"endLifetimeType":"INFINITE","startLifeTimeValue":"2018-08-25T12:14:23"}}],"name":"KeyChainObjectName1","overridable":true,"overrides":{"parent":{"id":"KeyChainUUID","type":"KeyChainObject"},"target":{"id":"domainUUID","name":"Global \\ ASIA \\ INDIA","type":"Domain"}},"type":"KeyChainObject"}}},"schema":{"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string"},"keys":{"items":{"type":"object","properties":{"acceptLifeTime":{"type":"object","properties":{"endLifeTimeValue":{"type":"string"},"endLifetimeType":{"enum":["INFINITE","DURATION","DATETIME"],"type":"string"},"startLifeTimeValue":{"type":"string"},"timeZone":{"type":"string"}},"$$ref":"#/components/schemas/ILifeTime"},"authAlgorithm":{"type":"string"},"authString":{"type":"object","properties":{"cryptoEncryptionType":{"enum":["PLAINTEXT"],"type":"string"},"cryptoKeyString":{"type":"string"}},"$$ref":"#/components/schemas/IAuthTypeAndString"},"keyId":{"format":"int32","type":"integer"},"sendLifeTime":{"type":"object","properties":{"endLifeTimeValue":{"type":"string"},"endLifetimeType":{"enum":["INFINITE","DURATION","DATETIME"],"type":"string"},"startLifeTimeValue":{"type":"string"},"timeZone":{"type":"string"}},"$$ref":"#/components/schemas/ILifeTime"}},"$$ref":"#/components/schemas/IKeyObject"},"type":"array"},"links":{"type":"object","properties":{"parent":{"type":"string"},"self":{"type":"string"}},"$$ref":"#/components/schemas/Links"},"metadata":{"type":"object","description":"Defines read only details about the object - whether it is system defined, last user who modified the object etc.","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":{"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"},"type":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/KeyChainObject"}}},"description":"Input representation of KeyChain object.","required":true},"responses":{"201":{"content":{"application/json":{"examples":{"Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/object/keychain ( POST method for Key Chain Object )":{"value":{"description":"description for keychain object","id":"KeyChainUUID","keys":[{"acceptLifeTime":{"endLifeTimeValue":"2018-08-27T12:14:23","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-25T12:14:23"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"keyString"},"keyId":2,"sendLifeTime":{"endLifeTimeValue":"234","endLifetimeType":"DURATION","startLifeTimeValue":"2018-08-25T12:14:23"}},{"acceptLifeTime":{"endLifeTimeValue":"2018-08-27T12:14:23","endLifetimeType":"INFINITE","startLifeTimeValue":"2018-08-25T12:14:23"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"keyString"},"keyId":24,"sendLifeTime":{"endLifetimeType":"INFINITE","startLifeTimeValue":"2018-08-25T12:14:23"}},{"acceptLifeTime":{"endLifeTimeValue":"2018-08-27T12:14:23","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-25T12:14:23"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"keyString"},"keyId":3,"sendLifeTime":{"endLifeTimeValue":"2018-08-27T12:14:23","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-25T12:14:23"}},{"acceptLifeTime":{"endLifeTimeValue":"2018-08-27T12:14:23","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-25T12:14:23"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"keyString"},"keyId":34,"sendLifeTime":{"endLifeTimeValue":"2018-08-27T12:14:23","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-25T12:14:23"}},{"acceptLifeTime":{"endLifeTimeValue":"2018-08-27T12:14:23","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-25T12:14:23"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"keyString"},"keyId":4,"sendLifeTime":{"endLifeTimeValue":"2018-08-27T12:14:23","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-25T12:14:23"}},{"acceptLifeTime":{"endLifeTimeValue":"2018-08-27T12:14:23","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-25T12:14:23"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"keyString"},"keyId":5,"sendLifeTime":{"endLifeTimeValue":"2018-08-27T12:14:23","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-25T12:14:23"}}],"links":{"self":"/api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID"},"metadata":{"domain":{"id":"DomainUUID","name":"Global"},"lastUser":{"name":"rest"},"timestamp":0},"name":"KeyChainObjectName1","overridable":false,"timeout":3,"type":"KeyChainObject"}},"Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/object/keychain?bulk=true ( POST method for Key Chain Bulk Object )":{"value":{"items":[{"description":"desciption","id":"KeyChainUUID","keys":[{"acceptLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"plaintext"},"keyId":1,"sendLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"}}],"links":{"self":"/api/fmc_config/v1/domain/DomainUUID/object/keychains/KeyChainUUID"},"metadata":{"domain":{"id":"DomainUUID","name":"Global"},"lastUser":{"name":"admin"},"timestamp":0},"name":"KeyChain1","overridable":false,"type":"KeyChainObject"},{"description":"desciption","id":"KeyChainUUID","keys":[{"acceptLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"plaintext"},"keyId":1,"sendLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"}}],"links":{"self":"/api/fmc_config/v1/domain/DomainUUID/object/keychains/KeyChainUUID"},"metadata":{"domain":{"id":"DomainUUID","name":"Global"},"lastUser":{"name":"admin"},"timestamp":0},"name":"keychain2","overridable":false,"type":"KeyChainObject"}],"links":{"self":"/api/fmc_config/v1/domain/DomainUUID/object/keychains?bulk=true"}}},"Example 3 : POST /api/fmc_config/v1/domain/DomainUUID/object/keychain?bulk=true ( POST method for Key Chain Object with Bulk Override )":{"value":{"items":[{"description":"override_keychain_rest_5","id":"KeyChainUUID","keys":[{"acceptLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"plaintext"},"keyId":1,"sendLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"}},{"acceptLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"plaintext"},"keyId":2,"sendLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"}},{"acceptLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"plaintext"},"keyId":3,"sendLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"}}],"links":{"self":"/api/fmc_config/v1/domain/DomainUUID/object/keychains/KeyChainUUID?overrideTargetId=DeviceUUID"},"metadata":{"domain":{"id":"DomainUUID","name":"Global \\ Domain_Network"},"lastUser":{"name":"admin"},"timestamp":0},"name":"parent_keychain_rest_6","overridable":true,"overrides":{"parent":{"id":"ParentKeyChainUUID","type":"KeyChainObject"},"target":{"id":"DeviceUUID","name":"DeviceName","type":"Device"}},"type":"KeyChainObject"},{"description":"override_keychain_rest_6","id":"KeyChainUUID","keys":[{"acceptLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"plaintext"},"keyId":1,"sendLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"}},{"acceptLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"plaintext"},"keyId":2,"sendLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"}},{"acceptLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"plaintext"},"keyId":3,"sendLifeTime":{"endLifeTimeValue":"2018-09-15T15:53:00","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-15T15:53:00"}}],"links":{"self":"/api/fmc_config/v1/domain/DomainUUID/object/keychains/KeyChainUUID?overrideTargetId=DeviceUUID"},"metadata":{"domain":{"id":"DomainUUID","name":"Global \\ Domain_Network"},"lastUser":{"name":"admin"},"timestamp":0},"name":"parent_keychain_rest_6","overridable":true,"overrides":{"parent":{"id":"ParentKeyChainUUID","type":"KeyChainObject"},"target":{"id":"DomainUUID","name":"DomainName","type":"Domain"}},"type":"KeyChainObject"}],"links":{"self":"/api/fmc_config/v1/domain/DomainUUID/object/keychains?bulk=true"}}},"Example 4 : POST /api/fmc_config/v1/domain/DomainUUID/object/keychain ( POST method for Key Chain override Object with device )":{"value":{"description":"description for keychain object","id":"KeyChainUUID","keys":[{"acceptLifeTime":{"endLifeTimeValue":"2018-08-27T12:14:23","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-25T12:14:23"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"keyString"},"keyId":2,"sendLifeTime":{"endLifeTimeValue":"234","endLifetimeType":"DURATION","startLifeTimeValue":"2018-08-25T12:14:23"}},{"acceptLifeTime":{"endLifeTimeValue":"2018-08-27T12:14:23","endLifetimeType":"INFINITE","startLifeTimeValue":"2018-08-25T12:14:23"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"keyString"},"keyId":24,"sendLifeTime":{"endLifetimeType":"INFINITE","startLifeTimeValue":"2018-08-25T12:14:23"}}],"links":{"self":"/api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID?overrideTargetId=deviceUUID"},"metadata":{"domain":{"id":"DomainUUID","name":"Global"},"lastUser":{"name":"rest"},"timestamp":0},"name":"KeyChainObjectName1","overridable":true,"overrides":{"parent":{"id":"KeyChainUUID","type":"KeyChainObject"},"target":{"id":"deviceUUID","name":"10.10.9.20","type":"Device"}},"timeout":3,"type":"KeyChainObject"}},"Example 5 : POST /api/fmc_config/v1/domain/DomainUUID/object/keychain ( POST method for Key Chain Object override with domain )":{"value":{"description":"description for keychain object","id":"KeyChainUUID","keys":[{"acceptLifeTime":{"endLifeTimeValue":"2018-08-27T12:14:23","endLifetimeType":"DATETIME","startLifeTimeValue":"2018-08-25T12:14:23"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"keyString"},"keyId":2,"sendLifeTime":{"endLifeTimeValue":"234","endLifetimeType":"DURATION","startLifeTimeValue":"2018-08-25T12:14:23"}},{"acceptLifeTime":{"endLifeTimeValue":"2018-08-27T12:14:23","endLifetimeType":"INFINITE","startLifeTimeValue":"2018-08-25T12:14:23"},"authAlgorithm":"md5","authString":{"cryptoEncryptionType":"PLAINTEXT","cryptoKeyString":"keyString"},"keyId":24,"sendLifeTime":{"endLifetimeType":"INFINITE","startLifeTimeValue":"2018-08-25T12:14:23"}}],"links":{"self":"/api/fmc_config/v1/domain/DomainUUID/object/keychain/KeyChainUUID?overrideTargetId=deviceUUID"},"metadata":{"domain":{"id":"DomainUUID","name":"Global"},"lastUser":{"name":"rest"},"timestamp":0},"name":"KeyChainObjectName1","overridable":true,"overrides":{"parent":{"id":"KeyChainUUID","type":"KeyChainObject"},"target":{"id":"domainUUID","name":"Global \\ ASIA \\ INDIA","type":"Domain"}},"timeout":3,"type":"KeyChainObject"}}},"schema":{"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string"},"keys":{"items":{"type":"object","properties":{"acceptLifeTime":{"type":"object","properties":{"endLifeTimeValue":{"type":"string"},"endLifetimeType":{"enum":["INFINITE","DURATION","DATETIME"],"type":"string"},"startLifeTimeValue":{"type":"string"},"timeZone":{"type":"string"}},"$$ref":"#/components/schemas/ILifeTime"},"authAlgorithm":{"type":"string"},"authString":{"type":"object","properties":{"cryptoEncryptionType":{"enum":["PLAINTEXT"],"type":"string"},"cryptoKeyString":{"type":"string"}},"$$ref":"#/components/schemas/IAuthTypeAndString"},"keyId":{"format":"int32","type":"integer"},"sendLifeTime":{"type":"object","properties":{"endLifeTimeValue":{"type":"string"},"endLifetimeType":{"enum":["INFINITE","DURATION","DATETIME"],"type":"string"},"startLifeTimeValue":{"type":"string"},"timeZone":{"type":"string"}},"$$ref":"#/components/schemas/ILifeTime"}},"$$ref":"#/components/schemas/IKeyObject"},"type":"array"},"links":{"type":"object","properties":{"parent":{"type":"string"},"self":{"type":"string"}},"$$ref":"#/components/schemas/Links"},"metadata":{"type":"object","description":"Defines read only details about the object - whether it is system defined, last user who modified the object etc.","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":{"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"},"type":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/KeyChainObject"}}},"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":"createMultipleKeyChainObject","method":"post","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/keychains"}}