Get All FTDRA Vpn LDAP Attribute Model - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get All FTDRA Vpn LDAP 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 containing all LDAP attribute maps inside a remote access VPN topology.**","operationId":"getAllFTDRAVpnLDAPAttributeModel","parameters":[{"description":"UUID of the ticket for tracking the configuration changes.","in":"header","name":"ticket-id","required":false,"schema":{"type":"string"}},{"description":"The container id under which this specific resource is contained.","in":"path","name":"containerUUID","required":true,"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/policy/ravpns/containerUUID/ldapattributemaps ( Get all LDAP Attribute Maps )":{"value":{"items":[{"id":"00505681-303E-0ed3-0000-004294968318","ldapAttributeMapList":[{"ldapAttributeMaps":[{"ciscoName":"Group-Policy","ldapName":"department","valueMappings":[{"groupPolicy":{"id":"00505681-303E-0ed3-0000-549755813894","name":"group_2","type":"GroupPolicy"},"ldapValue":"rest","type":"LdapToGroupPolicyMapping"},{"groupPolicy":{"id":"00505681-303E-0ed3-0000-098784247856","name":"group_policy_1","type":"GroupPolicy"},"ldapValue":"test","type":"LdapToGroupPolicyMapping"}]},{"ciscoName":"Banner1","ldapName":"mail","valueMappings":[{"ciscoValue":"test banner","ldapValue":"attr","type":"LdapToCiscoValueMapping"}]},{"ciscoName":"Firewall-ACL-In","ldapName":"memberOf","valueMappings":[{"acl":{"id":"00505681-303E-0ed3-0000-549755813913","name":"acl_1","type":"ExtendedAccessList"},"ldapValue":"acl","type":"LdapToAclMapping"}]}],"realm":{"id":"5dac6c26-5421-11ec-97cd-b79efba416a2","name":"realm_1","type":"Realm"}}],"links":{"self":"https://fmcip/api/fmc_config/v1/domain/DomainUUID/ravpns/containerUUID/ldapattributemaps/ldapattributemapUUID"},"metadata":{"domain":{"id":"e276abec-e0f2-11e3-8169-6d9ed49b625f","name":"Global","type":"Domain"},"lastUser":{"name":"admin"},"parentPolicy":{"id":"00505681-303E-0ed3-0000-004294968276","name":"ravpn_1","type":"RAVpn"},"timestamp":1639738208636},"name":"WebVPNUserGroupPolicy ","type":"RaVpnLdapAttributeMap"}],"links":{"self":"https://fmcip/api/fmc_config/v1/domain/DomainUUID/policy/ravpns/containerUUID/ldapattributemaps?offset=0&limit=25&expanded=true"},"paging":{"count":1,"limit":25,"offset":0,"pages":1}}}},"schema":{"type":"object","properties":{"items":{"type":"array","description":"A model representing LDAP Attribute Maps definition.","properties":{"description":{"type":"string"},"id":{"description":"Unique identifier representing response object.","type":"string"},"ldapAttributeMapList":{"description":"The attribute map equates attributes that exist in the Active Directory (AD) or LDAP server with Cisco attribute names and values","items":{"type":"object","description":"A model representing LDAP Attribute Setting definition.","properties":{"entry":{"type":"object","properties":{"attributeNameEntryList":{"items":{"type":"object","properties":{"attributeValueEntryList":{"items":{"type":"object","properties":{"ciscoAttributeObject":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/ObjectEntry"},"ciscoAttributeValue":{"type":"string"},"ldapAttributeValue":{"type":"string"},"valueType":{"enum":["LDAP_TO_CISCO_VALUE_MAPPING","LDAP_TO_GROUP_POLICY_MAPPING","LDAP_TO_ACL_MAPPING"],"type":"string"}},"$$ref":"#/components/schemas/LDAPAttributeValueEntry"},"type":"array"},"ciscoAttributeName":{"type":"string"},"ldapAttributeName":{"type":"string"}},"$$ref":"#/components/schemas/LDAPAttributeNameEntry"},"type":"array"},"attributes":{"type":"object","$$ref":"#/components/schemas/Attributes"},"description":{"type":"string"},"domainReadOnly":{"type":"boolean"},"group":{"type":"boolean"},"id":{"format":"int32","type":"integer"},"literal":{"type":"boolean"},"name":{"type":"string"},"readOnly":{"type":"boolean"},"realmEntry":{"type":"object","properties":{"attributes":{"type":"object","$$ref":"#/components/schemas/Attributes"},"description":{"type":"string"},"domainReadOnly":{"type":"boolean"},"group":{"type":"boolean"},"id":{"format":"int32","type":"integer"},"literal":{"type":"boolean"},"name":{"type":"string"},"readOnly":{"type":"boolean"},"references":{"type":"object","properties":{"type":{"type":"string"},"valueList":{"items":{"type":"object","properties":{"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/NamedEntry"},"type":"array"}},"$$ref":"#/components/schemas/ObjectRefs"},"subType":{"type":"string"},"systemObject":{"type":"boolean"},"toolTip":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"},"valueList":{"items":{"type":"object","properties":{"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/NamedEntry"},"type":"array"}},"$$ref":"#/components/schemas/PolicyObjectEntry"},"references":{"type":"object","properties":{"type":{"type":"string"},"valueList":{"items":{"type":"object","properties":{"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/NamedEntry"},"type":"array"}},"$$ref":"#/components/schemas/ObjectRefs"},"subType":{"type":"string"},"systemObject":{"type":"boolean"},"toolTip":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"},"valueList":{"items":{"type":"object","properties":{"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/NamedEntry"},"type":"array"}},"$$ref":"#/components/schemas/LDAPAttributeMapEntry"},"ldapAttributeMaps":{"description":"Specifies the mapping for ldap name and cisco name along with value mappings.","items":{"type":"object","description":"A model representing LDAP Attribute Setting definition.","properties":{"ciscoName":{"description":"Specifies the Cisco attribute name.","type":"string"},"entry":{"type":"object","properties":{"attributeValueEntryList":{"items":{"type":"object","properties":{"ciscoAttributeObject":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/ObjectEntry"},"ciscoAttributeValue":{"type":"string"},"ldapAttributeValue":{"type":"string"},"valueType":{"enum":["LDAP_TO_CISCO_VALUE_MAPPING","LDAP_TO_GROUP_POLICY_MAPPING","LDAP_TO_ACL_MAPPING"],"type":"string"}},"$$ref":"#/components/schemas/LDAPAttributeValueEntry"},"type":"array"},"ciscoAttributeName":{"type":"string"},"ldapAttributeName":{"type":"string"}},"$$ref":"#/components/schemas/LDAPAttributeNameEntry"},"ldapName":{"description":"Specifies the LDAP attribute name.","type":"string"},"valueMappings":{"description":"Specifies the value mappings.","items":{"type":"object","properties":{"ciscoValue":{"type":"string"},"extendedAccessList":{"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"},"groupPolicy":{"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"},"ldapValue":{"type":"string"},"valueType":{"type":"string"}},"$$ref":"#/components/schemas/ILDAPAttributeValue"},"type":"array"}},"$$ref":"#/components/schemas/LDAPAttributeMap"},"type":"array"},"ldapServer":{"description":"Specifies the AD/LDAP Realm for which the attribute mappings are defined.","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"}},"required":["ldapServer"],"$$ref":"#/components/schemas/LDAPAttributeMapModel"},"type":"array"},"links":{"description":"Object containing related links.","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 LDAP attribute Setting.","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":{"type":"string"},"type":{"description":"Type associated with resource: RaVpnLdapAttributeMaps.","type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/FTDRAVpnLDAPAttributeModel"},"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/FTDRAVpnLDAPAttributeModelListContainer"}}},"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":["Policy"],"__originalOperationId":"getAllFTDRAVpnLDAPAttributeModel","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/ldapattributemaps"}}