FTDRAVpnConnectionProfileModel - Security Cloud Control Firewall Manager API Documentation - Cisco DevNet

{"type":"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":{"description":"A model representing Connection Profile definition.","properties":{"accountingServer":{"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"},"allowConnectionOnlyIfAuthorized":{"description":"Allow VPN Session only if the user is authorized. Default is False","type":"boolean"},"authenticationMethod":{"description":"Method of authentication.","enum":["AAA_ONLY","SAML","CLIENT_CERTIFICATE_ONLY","AAA_AND_CLIENT_CERTIFICATE","SAML_AND_CLIENT_CERTIFICATE"],"type":"string"},"authorizationServer":{"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"},"certificateUsernameSettings":{"type":"object","description":"Settings used when user is authenticated using certificate.","properties":{"hideUsername":{"description":"Hide prefilled username field so that the user cannot modify it. Default is False.","type":"boolean"},"mapEntireDNAsUsername":{"description":"Use entire DN name to authenticate the certificate. Default is False.","type":"boolean"},"mapPrimaryField":{"description":"Field in the certificate that will be used as Primary attribute to authenticate. Default value is CN (Common Name)","enum":["CN_COMMMON_NAME","C_COUNTRY","DNQ_DN_QUALIFIER","EA_EMAIL_ADDRESS","GENQ_GENERATIONAL_QUALIFIER","GN_GIVEN_NAME","I_INITIAL","L_LOCALITY","N_NAME","O_ORGANISATION","OU_ORGANISATIONAL_UNIT","SER_SERIAL_NUMBER","SN_SURNAME","SP_STATE_PROVINCE","T_TITLE","UID_USER_ID","UPN_USER_PRINCIPAL_NAME","NONE"],"type":"string"},"mapSecondaryField":{"description":"Field in the certificate that will be used as Secondary attribute to authenticate. Default value is OU (Organization Unit)","enum":["CN_COMMMON_NAME","C_COUNTRY","DNQ_DN_QUALIFIER","EA_EMAIL_ADDRESS","GENQ_GENERATIONAL_QUALIFIER","GN_GIVEN_NAME","I_INITIAL","L_LOCALITY","N_NAME","O_ORGANISATION","OU_ORGANISATIONAL_UNIT","SER_SERIAL_NUMBER","SN_SURNAME","SP_STATE_PROVINCE","T_TITLE","UID_USER_ID","UPN_USER_PRINCIPAL_NAME","NONE"],"type":"string"},"matchCertificateAndSamlUsername":{"description":"Match SAML and certificate username for authentication. Default is False.","type":"boolean"},"prefillUsernameFromCertificate":{"description":"Prefill username from certificate when the user connects. Default is False.","type":"boolean"}},"$$ref":"#/components/schemas/IConnProfileCertificateUsernameSettings"},"description":{"description":"User provided resource description. ","type":"string"},"dhcpServersForAddressAssignment":{"items":{"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"},"type":"array"},"enableExternalBrowserForSAML":{"description":"Enable external browser package for SAML based Authentication method.","type":"boolean"},"enableMultipleCertificateAuthentication":{"description":"Enable multiple certificate authentication.","type":"boolean"},"enablePasswordManagement":{"description":"Allows the user to change the password, if the password is expired. Default is False","type":"boolean"},"enablePrimaryAuthFallbackToLocal":{"type":"boolean"},"enableSecondaryAuthFallbackToLocal":{"type":"boolean"},"enableSecondaryAuthentication":{"type":"boolean"},"groupAlias":{"items":{"type":"object","description":"Specifies alternate names by which the server can refer to a connection profile.","properties":{"aliasName":{"description":"User assigned resource alias name.","type":"string"},"enabled":{"description":"If set to True, then the group name appears in the login screen dropdown. Default is False.","type":"boolean"}},"$$ref":"#/components/schemas/IConnectionProfileGroupAlias"},"type":"array"},"groupPolicy":{"description":"Default group policy for the connection profile.","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"},"groupUrl":{"items":{"type":"object","description":"Identifies group URLs to automatically connect to the connection profile.","properties":{"aliasUrl":{"description":"URL object containing the url.","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"},"enabled":{"description":"User can connect to the connection profile directly using the alias url.","type":"boolean"}},"$$ref":"#/components/schemas/IConnectionProfileGroupUrl"},"type":"array"},"id":{"description":"Unique identifier representing this resource.","type":"string"},"idpCertOverrideForConnProfile":{"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"},"ipv4AddressPool":{"items":{"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"},"type":"array"},"ipv6AddressPool":{"items":{"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"},"type":"array"},"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 assigned resource name.","type":"string"},"notifyUserOnPasswordExpiryDay":{"description":"Notify ahead of the password expiry or on the day the password expires. Default is False.","type":"boolean"},"passwordExpirationNotificationPeriod":{"description":"Number of days to notify password expiry. Range is 0-180 days. Default is 14 days.","format":"int32","type":"integer"},"primaryAuthenticationServer":{"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"},"secondaryAuthenticationServer":{"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"},"secondaryAuthenticationSettings":{"type":"object","description":"Secondary authentication settings if double authentication enabled.","properties":{"certificateUsernameSettings":{"type":"object","description":"Settings used when user is authenticated using certificate.","properties":{"hideUsername":{"description":"Hide prefilled username field so that the user cannot modify it. Default is False.","type":"boolean"},"mapEntireDNAsUsername":{"description":"Use entire DN name to authenticate the certificate. Default is False.","type":"boolean"},"mapPrimaryField":{"description":"Field in the certificate that will be used as Primary attribute to authenticate. Default value is CN (Common Name)","enum":["CN_COMMMON_NAME","C_COUNTRY","DNQ_DN_QUALIFIER","EA_EMAIL_ADDRESS","GENQ_GENERATIONAL_QUALIFIER","GN_GIVEN_NAME","I_INITIAL","L_LOCALITY","N_NAME","O_ORGANISATION","OU_ORGANISATIONAL_UNIT","SER_SERIAL_NUMBER","SN_SURNAME","SP_STATE_PROVINCE","T_TITLE","UID_USER_ID","UPN_USER_PRINCIPAL_NAME","NONE"],"type":"string"},"mapSecondaryField":{"description":"Field in the certificate that will be used as Secondary attribute to authenticate. Default value is OU (Organization Unit)","enum":["CN_COMMMON_NAME","C_COUNTRY","DNQ_DN_QUALIFIER","EA_EMAIL_ADDRESS","GENQ_GENERATIONAL_QUALIFIER","GN_GIVEN_NAME","I_INITIAL","L_LOCALITY","N_NAME","O_ORGANISATION","OU_ORGANISATIONAL_UNIT","SER_SERIAL_NUMBER","SN_SURNAME","SP_STATE_PROVINCE","T_TITLE","UID_USER_ID","UPN_USER_PRINCIPAL_NAME","NONE"],"type":"string"},"matchCertificateAndSamlUsername":{"description":"Match SAML and certificate username for authentication. Default is False.","type":"boolean"},"prefillUsernameFromCertificate":{"description":"Prefill username from certificate when the user connects. Default is False.","type":"boolean"}},"$$ref":"#/components/schemas/IConnProfileCertificateUsernameSettings"},"mapUsernameFromCertificate":{"description":"Use the username from Certificate.","type":"boolean"},"promptUsername":{"description":"Allow user to enter Username and Password.","type":"boolean"},"usePrimaryUsername":{"description":"Use the same username that is used with Primary Authentication Server.","type":"boolean"},"useSecondaryUsernameforSession":{"description":"Secondary username is used for reporting user activity.","type":"boolean"}},"$$ref":"#/components/schemas/ISecondaryAuthenticationSettings"},"stripGroupFromUsername":{"description":"If set to true, removes the group name from the username before passing the username on to the AAA server. Default is False","type":"boolean"},"stripRealmFromUsername":{"description":"If set to true, removes the realm from the username before passing the username on to the AAA server. Default is False","type":"boolean"},"type":{"description":"Type associated with resource: RaVpnConnectionProfile.","type":"string"},"useLocalAsPrimaryAuthServer":{"type":"boolean"},"useLocalAsSecondaryAuthServer":{"type":"boolean"},"version":{"description":"Version number of the response object.","type":"string"}},"required":["authenticationMethod","groupPolicy"],"type":"object","title":"FTDRAVpnConnectionProfileModel"}}