HTTP Server

Overview

This document describes the API to configure AAA HTTP servers and their properties in BIG-IQ.

REST Endpoint: /cm/access/working-config/apm/aaa/http

Requests

GET /cm/access/working-config/apm/aaa/http/<id>

Request Parameters

None

Query Parameters

None

Response

HTTP/1.1 200 OK

Name Type Description
authType string Specify the authentication Type as Form Based, Basic/NTLM, or Custom Post.Form Based to direct users to a form action URL and to provide the specified form parameters. Use Basic/NTLM to direct users to a URI. Use Custom Post to direct users to either POST URL, a submit URL, or a relative URL and to provide the specified content.
contentType string Specify an encoding for the HTTP custom post. The default setting is XML-UTF8. Note: if you select None, add a header in the Custom Headers fields and apply your own encoding through an iRule.
customBody string Specify the body of the HTTP Custom Post.
followRedirect number Specify the number that indicating how many pages away from the landing page the request can travel before it fails.
formAction string Form Action value is required when Authentication type is form-based or custom-post. For FormBased configuration, Specify the complete destination URL for processing the form. The form action URL specifies where HTTP form-based authentication occurs. If you do not specify a form action, APM uses the URI from the request to perform HTTP form-based authentication. Specify the complete destination URL for processing the form. The form action URL specifies where HTTP form-based authentication occurs. If you do not specify a form action, APM uses the URI from the request to perform HTTP form-based authentication. For Custom Post configuration, enter either the POST URL, submit URL or a relative URL.
formFields string Specify the authentication server logon form at your location. The logon form requires hidden form parameters and values.
formMethod string Specify either GET or POST as form Methods. If you select GET, the authentication request converts to HTTP GET. The default value is post.
formPassword string Specify the parameter password that the form, to which you are sending the POST request, uses.
formUsername string Specify the parameter name that the form, to which you are sending the POST request, uses.
headers array_of_objects Specify the names and values for header content to insert in the HTTP custom post.
     tmName string Name of the header content to insert in the HTTP custom post.
     value string Value of the header content to insert in the HTTP custom post.
     name string Unique name with name and ID that is different then other names and values in the headers.
startUri string Specify a URL resource that responds with a challenge to a non-authenticated request. Start URI is required if authentication type is basic-ntlm. For Form-Based, a Start URI entry is optional, because you must specify either an absolute or a relative URL resource in the Form Action field. If you specify both parameters, APM uses both of them as the final URL for HTTP POST. If you specify the Form Action parameter only, APM is likely to detect that the absolute URI based on it should be used for HTTP POST. Note for Custom Post authentication type: If you do not specify a Start URI, APM will likely detect that the absolute URI based on the Form Action parameter should be used for HTTP POST. If you specify a Start URI, APM uses both the Start URI and the Form Action parameters as the final URL for HTTP POST.
successMatchType string Specify the method that your authentication server uses and then specify the required information in the successful logon detection match value. Enter the url for match value if the match type is a URL. Enter a string for match value if the match type is string. Enter a cookie for match value if the match type is a cookie. With this match type, when APM receives a duplicate cookie, APM adds it to the existing cookie list. As a result, multiple cookies with the same name, domain, and path can exist. Here is an example, issosession=first; path=/; domain=mycompany.com and issosession=second; path=/; domain= mycompany.com In this case, there are two cookies, and APM searches them both. If exact-cookie is selected as match type, enter the exact key fields (name, path, and domain) that are present in the HTTP response cookie in the Successful Logon Detection Match Value field. To match an HTTP response cookie that contains three key fields, specify all three in the Successful Logon Detection Match Value field, as shown in this example. issosession=value;path=/;domain=mycompanynet.com; To match an HTTP response cookie that contains a subset of the key fields, such as name and path, specify those keys only, as shown in this example: issosession=any;path=/;. Note: Failure to supply the exact number of keys and exact values for the HTTP response cookie results in a No matching cookie found error message. Note: This match type supports cookie merge functionality. When APM receives a cookie with the same name, domain, and path as an existing cookie, APM merges it into the existing cookie. Here are two cookies each with the same name, domain, and path: issosession=first; path=/; domain=mycompany.com issosession=second; path=/; domain= mycompany.com In this case, the second cookie replaces the first cookie.
successMatchValue string Enter the URL, cookie, specific string or exact keys used for the specific Successful logon detection match type you selected.
name string The name of the object
partition string The BIG-IP partition where the object should be placed
subPath string The BIG-IP folder where the object should be placed
lsoDeviceReference reference Reference to the device
     id string Id of the device.
     name string Device name. Typically it is device’s hostname.
     kind string Kind of the device.
     machineId string Machine ID of the device.
     link string URI link of the reference.
isLsoShared boolean Specifies if the location-specific object instance is shared across all devices. Use this only during POST. Warning: Do not flip this flag during PUT/PATCH operations.
deviceGroupReference reference Reference to the device group.
     name string Name of the resource
     kind string The kind of the resource.
     link string URI link of the reference.
id string An ID of an application
kind string The kind of application.
selfLink string The selfLink of an application.

Error Response

HTTP/1.1 400 Bad Request

This response status is related to error conditions. A detailed error message displays in the response.

HTTP/1.1 401 Unauthorized

This response happens when access is denied due to invalid credentials(no Permission).

Permissions

Role Allow
Application_Editor Yes
Service_Catalog_Viewer Yes
Service_Catalog_Editor Yes
Trust_Discovery_Import Yes
Access_View Yes
Access_Edit Yes
Access_Manager Yes
Application_Manager Yes
Application_Viewer Yes
Trust_Discovery_Import Yes
Access_Deploy Yes
Access_Policy_Editor Yes

POST /cm/access/working-config/apm/aaa/http

Request Parameters

Name Type Required Description
authType string True Specify the authentication Type as Form Based, Basic/NTLM, or Custom Post.Form Based to direct users to a form action URL and to provide the specified form parameters. Use Basic/NTLM to direct users to a URI. Use Custom Post to direct users to either POST URL, a submit URL, or a relative URL and to provide the specified content.
contentType string False Specify an encoding for the HTTP custom post. The default setting is XML-UTF8. Note: if you select None, add a header in the Custom Headers fields and apply your own encoding through an iRule.
customBody string False Specify the body of the HTTP Custom Post.
followRedirect number True Specify the number that indicating how many pages away from the landing page the request can travel before it fails.
formAction string True Form Action value is required when Authentication type is form-based or custom-post. For FormBased configuration, Specify the complete destination URL for processing the form. The form action URL specifies where HTTP form-based authentication occurs. If you do not specify a form action, APM uses the URI from the request to perform HTTP form-based authentication. Specify the complete destination URL for processing the form. The form action URL specifies where HTTP form-based authentication occurs. If you do not specify a form action, APM uses the URI from the request to perform HTTP form-based authentication. For Custom Post configuration, enter either the POST URL, submit URL or a relative URL.
formFields string False Specify the authentication server logon form at your location. The logon form requires hidden form parameters and values.
formMethod string True Specify either GET or POST as form Methods. If you select GET, the authentication request converts to HTTP GET. The default value is post.
formPassword string False Specify the parameter password that the form, to which you are sending the POST request, uses.
formUsername string False Specify the parameter name that the form, to which you are sending the POST request, uses.
headers array_of_objects False Specify the names and values for header content to insert in the HTTP custom post.
     tmName string False Name of the header content to insert in the HTTP custom post.
     value string False Value of the header content to insert in the HTTP custom post.
     name string True Unique name with name and ID that is different then other names and values in the headers.
startUri string False Specify a URL resource that responds with a challenge to a non-authenticated request. Start URI is required if authentication type is basic-ntlm. For Form-Based, a Start URI entry is optional, because you must specify either an absolute or a relative URL resource in the Form Action field. If you specify both parameters, APM uses both of them as the final URL for HTTP POST. If you specify the Form Action parameter only, APM is likely to detect that the absolute URI based on it should be used for HTTP POST. Note for Custom Post authentication type: If you do not specify a Start URI, APM will likely detect that the absolute URI based on the Form Action parameter should be used for HTTP POST. If you specify a Start URI, APM uses both the Start URI and the Form Action parameters as the final URL for HTTP POST.
successMatchType string False Specify the method that your authentication server uses and then specify the required information in the successful logon detection match value. Enter the url for match value if the match type is a URL. Enter a string for match value if the match type is string. Enter a cookie for match value if the match type is a cookie. With this match type, when APM receives a duplicate cookie, APM adds it to the existing cookie list. As a result, multiple cookies with the same name, domain, and path can exist. Here is an example, issosession=first; path=/; domain=mycompany.com and issosession=second; path=/; domain= mycompany.com In this case, there are two cookies, and APM searches them both. If exact-cookie is selected as match type, enter the exact key fields (name, path, and domain) that are present in the HTTP response cookie in the Successful Logon Detection Match Value field. To match an HTTP response cookie that contains three key fields, specify all three in the Successful Logon Detection Match Value field, as shown in this example. issosession=value;path=/;domain=mycompanynet.com; To match an HTTP response cookie that contains a subset of the key fields, such as name and path, specify those keys only, as shown in this example: issosession=any;path=/;. Note: Failure to supply the exact number of keys and exact values for the HTTP response cookie results in a No matching cookie found error message. Note: This match type supports cookie merge functionality. When APM receives a cookie with the same name, domain, and path as an existing cookie, APM merges it into the existing cookie. Here are two cookies each with the same name, domain, and path: issosession=first; path=/; domain=mycompany.com issosession=second; path=/; domain= mycompany.com In this case, the second cookie replaces the first cookie.
successMatchValue string True Enter the URL, cookie, specific string or exact keys used for the specific Successful logon detection match type you selected.
name string True The name of the object
partition string True The BIG-IP partition where the object should be placed
subPath string False The BIG-IP folder where the object should be placed
lsoDeviceReference reference False Reference to the device
     id string False Id of the device.
     link string False URI link of the reference.
isLsoShared boolean True Specifies if the location-specific object instance is shared across all devices. Use this only during POST. Warning: Do not flip this flag during PUT/PATCH operations.
deviceGroupReference reference False Reference to the device group.
     link string False URI link of the reference.

Query Parameters

None

Response

HTTP/1.1 200 OK

Name Type Description
authType string Specify the authentication Type as Form Based, Basic/NTLM, or Custom Post.Form Based to direct users to a form action URL and to provide the specified form parameters. Use Basic/NTLM to direct users to a URI. Use Custom Post to direct users to either POST URL, a submit URL, or a relative URL and to provide the specified content.
contentType string Specify an encoding for the HTTP custom post. The default setting is XML-UTF8. Note: if you select None, add a header in the Custom Headers fields and apply your own encoding through an iRule.
customBody string Specify the body of the HTTP Custom Post.
followRedirect number Specify the number that indicating how many pages away from the landing page the request can travel before it fails.
formAction string Form Action value is required when Authentication type is form-based or custom-post. For FormBased configuration, Specify the complete destination URL for processing the form. The form action URL specifies where HTTP form-based authentication occurs. If you do not specify a form action, APM uses the URI from the request to perform HTTP form-based authentication. Specify the complete destination URL for processing the form. The form action URL specifies where HTTP form-based authentication occurs. If you do not specify a form action, APM uses the URI from the request to perform HTTP form-based authentication. For Custom Post configuration, enter either the POST URL, submit URL or a relative URL.
formFields string Specify the authentication server logon form at your location. The logon form requires hidden form parameters and values.
formMethod string Specify either GET or POST as form Methods. If you select GET, the authentication request converts to HTTP GET. The default value is post.
formPassword string Specify the parameter password that the form, to which you are sending the POST request, uses.
formUsername string Specify the parameter name that the form, to which you are sending the POST request, uses.
headers array_of_objects Specify the names and values for header content to insert in the HTTP custom post.
     tmName string Name of the header content to insert in the HTTP custom post.
     value string Value of the header content to insert in the HTTP custom post.
     name string Unique name with name and ID that is different then other names and values in the headers.
startUri string Specify a URL resource that responds with a challenge to a non-authenticated request. Start URI is required if authentication type is basic-ntlm. For Form-Based, a Start URI entry is optional, because you must specify either an absolute or a relative URL resource in the Form Action field. If you specify both parameters, APM uses both of them as the final URL for HTTP POST. If you specify the Form Action parameter only, APM is likely to detect that the absolute URI based on it should be used for HTTP POST. Note for Custom Post authentication type: If you do not specify a Start URI, APM will likely detect that the absolute URI based on the Form Action parameter should be used for HTTP POST. If you specify a Start URI, APM uses both the Start URI and the Form Action parameters as the final URL for HTTP POST.
successMatchType string Specify the method that your authentication server uses and then specify the required information in the successful logon detection match value. Enter the url for match value if the match type is a URL. Enter a string for match value if the match type is string. Enter a cookie for match value if the match type is a cookie. With this match type, when APM receives a duplicate cookie, APM adds it to the existing cookie list. As a result, multiple cookies with the same name, domain, and path can exist. Here is an example, issosession=first; path=/; domain=mycompany.com and issosession=second; path=/; domain= mycompany.com In this case, there are two cookies, and APM searches them both. If exact-cookie is selected as match type, enter the exact key fields (name, path, and domain) that are present in the HTTP response cookie in the Successful Logon Detection Match Value field. To match an HTTP response cookie that contains three key fields, specify all three in the Successful Logon Detection Match Value field, as shown in this example. issosession=value;path=/;domain=mycompanynet.com; To match an HTTP response cookie that contains a subset of the key fields, such as name and path, specify those keys only, as shown in this example: issosession=any;path=/;. Note: Failure to supply the exact number of keys and exact values for the HTTP response cookie results in a No matching cookie found error message. Note: This match type supports cookie merge functionality. When APM receives a cookie with the same name, domain, and path as an existing cookie, APM merges it into the existing cookie. Here are two cookies each with the same name, domain, and path: issosession=first; path=/; domain=mycompany.com issosession=second; path=/; domain= mycompany.com In this case, the second cookie replaces the first cookie.
successMatchValue string Enter the URL, cookie, specific string or exact keys used for the specific Successful logon detection match type you selected.
name string The name of the object
partition string The BIG-IP partition where the object should be placed
subPath string The BIG-IP folder where the object should be placed
lsoDeviceReference reference Reference to the device
     id string Id of the device.
     name string Device name. Typically it is device’s hostname.
     kind string Kind of the device.
     machineId string Machine ID of the device.
     link string URI link of the reference.
isLsoShared boolean Specifies if the location-specific object instance is shared across all devices. Use this only during POST. Warning: Do not flip this flag during PUT/PATCH operations.
deviceGroupReference reference Reference to the device group.
     name string Name of the resource
     kind string The kind of the resource.
     link string URI link of the reference.
id string An ID of an application
kind string The kind of application.
selfLink string The selfLink of an application.

Error Response

HTTP/1.1 400 Bad Request

This response status is related to error conditions. A detailed error message displays in the response.

HTTP/1.1 401 Unauthorized

This response happens when access is denied due to invalid credentials(no Permission).

Permissions

Role Allow
Application_Editor No
Service_Catalog_Viewer No
Service_Catalog_Editor No
Trust_Discovery_Import Yes
Access_View No
Access_Edit Yes
Access_Manager Yes
Application_Manager No
Application_Viewer No
Trust_Discovery_Import No
Access_Deploy No
Access_Policy_Editor No

PUT /cm/access/working-config/apm/aaa/http/<id>

Request Parameters

Name Type Required Description
authType string True Specify the authentication Type as Form Based, Basic/NTLM, or Custom Post.Form Based to direct users to a form action URL and to provide the specified form parameters. Use Basic/NTLM to direct users to a URI. Use Custom Post to direct users to either POST URL, a submit URL, or a relative URL and to provide the specified content.
contentType string False Specify an encoding for the HTTP custom post. The default setting is XML-UTF8. Note: if you select None, add a header in the Custom Headers fields and apply your own encoding through an iRule.
customBody string False Specify the body of the HTTP Custom Post.
followRedirect number False Specify the number that indicating how many pages away from the landing page the request can travel before it fails.
formAction string False Form Action value is required when Authentication type is form-based or custom-post. For FormBased configuration, Specify the complete destination URL for processing the form. The form action URL specifies where HTTP form-based authentication occurs. If you do not specify a form action, APM uses the URI from the request to perform HTTP form-based authentication. Specify the complete destination URL for processing the form. The form action URL specifies where HTTP form-based authentication occurs. If you do not specify a form action, APM uses the URI from the request to perform HTTP form-based authentication. For Custom Post configuration, enter either the POST URL, submit URL or a relative URL.
formFields string False Specify the authentication server logon form at your location. The logon form requires hidden form parameters and values.
formMethod string True Specify either GET or POST as form Methods. If you select GET, the authentication request converts to HTTP GET. The default value is post.
formPassword string False Specify the parameter password that the form, to which you are sending the POST request, uses.
formUsername string False Specify the parameter name that the form, to which you are sending the POST request, uses.
headers array_of_objects False Specify the names and values for header content to insert in the HTTP custom post.
     tmName string False Name of the header content to insert in the HTTP custom post.
     value string False Value of the header content to insert in the HTTP custom post.
     name string False Unique name with name and ID that is different then other names and values in the headers.
startUri string False Specify a URL resource that responds with a challenge to a non-authenticated request. Start URI is required if authentication type is basic-ntlm. For Form-Based, a Start URI entry is optional, because you must specify either an absolute or a relative URL resource in the Form Action field. If you specify both parameters, APM uses both of them as the final URL for HTTP POST. If you specify the Form Action parameter only, APM is likely to detect that the absolute URI based on it should be used for HTTP POST. Note for Custom Post authentication type: If you do not specify a Start URI, APM will likely detect that the absolute URI based on the Form Action parameter should be used for HTTP POST. If you specify a Start URI, APM uses both the Start URI and the Form Action parameters as the final URL for HTTP POST.
successMatchType string False Specify the method that your authentication server uses and then specify the required information in the successful logon detection match value. Enter the url for match value if the match type is a URL. Enter a string for match value if the match type is string. Enter a cookie for match value if the match type is a cookie. With this match type, when APM receives a duplicate cookie, APM adds it to the existing cookie list. As a result, multiple cookies with the same name, domain, and path can exist. Here is an example, issosession=first; path=/; domain=mycompany.com and issosession=second; path=/; domain= mycompany.com In this case, there are two cookies, and APM searches them both. If exact-cookie is selected as match type, enter the exact key fields (name, path, and domain) that are present in the HTTP response cookie in the Successful Logon Detection Match Value field. To match an HTTP response cookie that contains three key fields, specify all three in the Successful Logon Detection Match Value field, as shown in this example. issosession=value;path=/;domain=mycompanynet.com; To match an HTTP response cookie that contains a subset of the key fields, such as name and path, specify those keys only, as shown in this example: issosession=any;path=/;. Note: Failure to supply the exact number of keys and exact values for the HTTP response cookie results in a No matching cookie found error message. Note: This match type supports cookie merge functionality. When APM receives a cookie with the same name, domain, and path as an existing cookie, APM merges it into the existing cookie. Here are two cookies each with the same name, domain, and path: issosession=first; path=/; domain=mycompany.com issosession=second; path=/; domain= mycompany.com In this case, the second cookie replaces the first cookie.
successMatchValue string True Enter the URL, cookie, specific string or exact keys used for the specific Successful logon detection match type you selected.
name string False The name of the object
partition string False The BIG-IP partition where the object should be placed
subPath string False The BIG-IP folder where the object should be placed
lsoDeviceReference reference False Reference to the device
     id string False Id of the device.
     name string False Device name. Typically it is device’s hostname.
     kind string False Kind of the device.
     machineId string False Machine ID of the device.
     link string False URI link of the reference.
isLsoShared boolean False Specifies if the location-specific object instance is shared across all devices. Use this only during POST. Warning: Do not flip this flag during PUT/PATCH operations.
deviceGroupReference reference False Reference to the device group.
     name string False Name of the resource
     kind string False The kind of the resource.
     link string False URI link of the reference.
id string False An ID of an application
kind string False The kind of application.
selfLink string False The selfLink of an application.

Query Parameters

None

Response

HTTP/1.1 200 OK

Name Type Description
authType string Specify the authentication Type as Form Based, Basic/NTLM, or Custom Post.Form Based to direct users to a form action URL and to provide the specified form parameters. Use Basic/NTLM to direct users to a URI. Use Custom Post to direct users to either POST URL, a submit URL, or a relative URL and to provide the specified content.
contentType string Specify an encoding for the HTTP custom post. The default setting is XML-UTF8. Note: if you select None, add a header in the Custom Headers fields and apply your own encoding through an iRule.
customBody string Specify the body of the HTTP Custom Post.
followRedirect number Specify the number that indicating how many pages away from the landing page the request can travel before it fails.
formAction string Form Action value is required when Authentication type is form-based or custom-post. For FormBased configuration, Specify the complete destination URL for processing the form. The form action URL specifies where HTTP form-based authentication occurs. If you do not specify a form action, APM uses the URI from the request to perform HTTP form-based authentication. Specify the complete destination URL for processing the form. The form action URL specifies where HTTP form-based authentication occurs. If you do not specify a form action, APM uses the URI from the request to perform HTTP form-based authentication. For Custom Post configuration, enter either the POST URL, submit URL or a relative URL.
formFields string Specify the authentication server logon form at your location. The logon form requires hidden form parameters and values.
formMethod string Specify either GET or POST as form Methods. If you select GET, the authentication request converts to HTTP GET. The default value is post.
formPassword string Specify the parameter password that the form, to which you are sending the POST request, uses.
formUsername string Specify the parameter name that the form, to which you are sending the POST request, uses.
headers array_of_objects Specify the names and values for header content to insert in the HTTP custom post.
     tmName string Name of the header content to insert in the HTTP custom post.
     value string Value of the header content to insert in the HTTP custom post.
     name string Unique name with name and ID that is different then other names and values in the headers.
startUri string Specify a URL resource that responds with a challenge to a non-authenticated request. Start URI is required if authentication type is basic-ntlm. For Form-Based, a Start URI entry is optional, because you must specify either an absolute or a relative URL resource in the Form Action field. If you specify both parameters, APM uses both of them as the final URL for HTTP POST. If you specify the Form Action parameter only, APM is likely to detect that the absolute URI based on it should be used for HTTP POST. Note for Custom Post authentication type: If you do not specify a Start URI, APM will likely detect that the absolute URI based on the Form Action parameter should be used for HTTP POST. If you specify a Start URI, APM uses both the Start URI and the Form Action parameters as the final URL for HTTP POST.
successMatchType string Specify the method that your authentication server uses and then specify the required information in the successful logon detection match value. Enter the url for match value if the match type is a URL. Enter a string for match value if the match type is string. Enter a cookie for match value if the match type is a cookie. With this match type, when APM receives a duplicate cookie, APM adds it to the existing cookie list. As a result, multiple cookies with the same name, domain, and path can exist. Here is an example, issosession=first; path=/; domain=mycompany.com and issosession=second; path=/; domain= mycompany.com In this case, there are two cookies, and APM searches them both. If exact-cookie is selected as match type, enter the exact key fields (name, path, and domain) that are present in the HTTP response cookie in the Successful Logon Detection Match Value field. To match an HTTP response cookie that contains three key fields, specify all three in the Successful Logon Detection Match Value field, as shown in this example. issosession=value;path=/;domain=mycompanynet.com; To match an HTTP response cookie that contains a subset of the key fields, such as name and path, specify those keys only, as shown in this example: issosession=any;path=/;. Note: Failure to supply the exact number of keys and exact values for the HTTP response cookie results in a No matching cookie found error message. Note: This match type supports cookie merge functionality. When APM receives a cookie with the same name, domain, and path as an existing cookie, APM merges it into the existing cookie. Here are two cookies each with the same name, domain, and path: issosession=first; path=/; domain=mycompany.com issosession=second; path=/; domain= mycompany.com In this case, the second cookie replaces the first cookie.
successMatchValue string Enter the URL, cookie, specific string or exact keys used for the specific Successful logon detection match type you selected.
name string The name of the object
partition string The BIG-IP partition where the object should be placed
subPath string The BIG-IP folder where the object should be placed
lsoDeviceReference reference Reference to the device
     id string Id of the device.
     name string Device name. Typically it is device’s hostname.
     kind string Kind of the device.
     machineId string Machine ID of the device.
     link string URI link of the reference.
isLsoShared boolean Specifies if the location-specific object instance is shared across all devices. Use this only during POST. Warning: Do not flip this flag during PUT/PATCH operations.
deviceGroupReference reference Reference to the device group.
     name string Name of the resource
     kind string The kind of the resource.
     link string URI link of the reference.
id string An ID of an application
kind string The kind of application.
selfLink string The selfLink of an application.

Error Response

HTTP/1.1 400 Bad Request

This response status is related to error conditions. A detailed error message displays in the response.

HTTP/1.1 401 Unauthorized

This response happens when access is denied due to invalid credentials(no Permission).

Permissions

Role Allow
Application_Editor No
Service_Catalog_Viewer No
Service_Catalog_Editor No
Trust_Discovery_Import Yes
Access_View No
Access_Edit Yes
Access_Manager Yes
Application_Manager No
Application_Viewer No
Trust_Discovery_Import No
Access_Deploy No
Access_Policy_Editor No

PATCH /cm/access/working-config/apm/aaa/http/<id>

Request Parameters

Name Type Required Description
authType string True Specify the authentication Type as Form Based, Basic/NTLM, or Custom Post.Form Based to direct users to a form action URL and to provide the specified form parameters. Use Basic/NTLM to direct users to a URI. Use Custom Post to direct users to either POST URL, a submit URL, or a relative URL and to provide the specified content.
contentType string False Specify an encoding for the HTTP custom post. The default setting is XML-UTF8. Note: if you select None, add a header in the Custom Headers fields and apply your own encoding through an iRule.
customBody string False Specify the body of the HTTP Custom Post.
followRedirect number False Specify the number that indicating how many pages away from the landing page the request can travel before it fails.
formAction string False Form Action value is required when Authentication type is form-based or custom-post. For FormBased configuration, Specify the complete destination URL for processing the form. The form action URL specifies where HTTP form-based authentication occurs. If you do not specify a form action, APM uses the URI from the request to perform HTTP form-based authentication. Specify the complete destination URL for processing the form. The form action URL specifies where HTTP form-based authentication occurs. If you do not specify a form action, APM uses the URI from the request to perform HTTP form-based authentication. For Custom Post configuration, enter either the POST URL, submit URL or a relative URL.
formFields string False Specify the authentication server logon form at your location. The logon form requires hidden form parameters and values.
formMethod string True Specify either GET or POST as form Methods. If you select GET, the authentication request converts to HTTP GET. The default value is post.
formPassword string False Specify the parameter password that the form, to which you are sending the POST request, uses.
formUsername string False Specify the parameter name that the form, to which you are sending the POST request, uses.
headers array_of_objects False Specify the names and values for header content to insert in the HTTP custom post.
     tmName string False Name of the header content to insert in the HTTP custom post.
     value string False Value of the header content to insert in the HTTP custom post.
     name string False Unique name with name and ID that is different then other names and values in the headers.
startUri string False Specify a URL resource that responds with a challenge to a non-authenticated request. Start URI is required if authentication type is basic-ntlm. For Form-Based, a Start URI entry is optional, because you must specify either an absolute or a relative URL resource in the Form Action field. If you specify both parameters, APM uses both of them as the final URL for HTTP POST. If you specify the Form Action parameter only, APM is likely to detect that the absolute URI based on it should be used for HTTP POST. Note for Custom Post authentication type: If you do not specify a Start URI, APM will likely detect that the absolute URI based on the Form Action parameter should be used for HTTP POST. If you specify a Start URI, APM uses both the Start URI and the Form Action parameters as the final URL for HTTP POST.
successMatchType string False Specify the method that your authentication server uses and then specify the required information in the successful logon detection match value. Enter the url for match value if the match type is a URL. Enter a string for match value if the match type is string. Enter a cookie for match value if the match type is a cookie. With this match type, when APM receives a duplicate cookie, APM adds it to the existing cookie list. As a result, multiple cookies with the same name, domain, and path can exist. Here is an example, issosession=first; path=/; domain=mycompany.com and issosession=second; path=/; domain= mycompany.com In this case, there are two cookies, and APM searches them both. If exact-cookie is selected as match type, enter the exact key fields (name, path, and domain) that are present in the HTTP response cookie in the Successful Logon Detection Match Value field. To match an HTTP response cookie that contains three key fields, specify all three in the Successful Logon Detection Match Value field, as shown in this example. issosession=value;path=/;domain=mycompanynet.com; To match an HTTP response cookie that contains a subset of the key fields, such as name and path, specify those keys only, as shown in this example: issosession=any;path=/;. Note: Failure to supply the exact number of keys and exact values for the HTTP response cookie results in a No matching cookie found error message. Note: This match type supports cookie merge functionality. When APM receives a cookie with the same name, domain, and path as an existing cookie, APM merges it into the existing cookie. Here are two cookies each with the same name, domain, and path: issosession=first; path=/; domain=mycompany.com issosession=second; path=/; domain= mycompany.com In this case, the second cookie replaces the first cookie.
successMatchValue string True Enter the URL, cookie, specific string or exact keys used for the specific Successful logon detection match type you selected.
isLsoShared boolean False Specifies if the location-specific object instance is shared across all devices. Use this only during POST. Warning: Do not flip this flag during PUT/PATCH operations.

Query Parameters

None

Response

HTTP/1.1 200 OK

Name Type Description
authType string Specify the authentication Type as Form Based, Basic/NTLM, or Custom Post.Form Based to direct users to a form action URL and to provide the specified form parameters. Use Basic/NTLM to direct users to a URI. Use Custom Post to direct users to either POST URL, a submit URL, or a relative URL and to provide the specified content.
contentType string Specify an encoding for the HTTP custom post. The default setting is XML-UTF8. Note: if you select None, add a header in the Custom Headers fields and apply your own encoding through an iRule.
customBody string Specify the body of the HTTP Custom Post.
followRedirect number Specify the number that indicating how many pages away from the landing page the request can travel before it fails.
formAction string Form Action value is required when Authentication type is form-based or custom-post. For FormBased configuration, Specify the complete destination URL for processing the form. The form action URL specifies where HTTP form-based authentication occurs. If you do not specify a form action, APM uses the URI from the request to perform HTTP form-based authentication. Specify the complete destination URL for processing the form. The form action URL specifies where HTTP form-based authentication occurs. If you do not specify a form action, APM uses the URI from the request to perform HTTP form-based authentication. For Custom Post configuration, enter either the POST URL, submit URL or a relative URL.
formFields string Specify the authentication server logon form at your location. The logon form requires hidden form parameters and values.
formMethod string Specify either GET or POST as form Methods. If you select GET, the authentication request converts to HTTP GET. The default value is post.
formPassword string Specify the parameter password that the form, to which you are sending the POST request, uses.
formUsername string Specify the parameter name that the form, to which you are sending the POST request, uses.
headers array_of_objects Specify the names and values for header content to insert in the HTTP custom post.
     tmName string Name of the header content to insert in the HTTP custom post.
     value string Value of the header content to insert in the HTTP custom post.
     name string Unique name with name and ID that is different then other names and values in the headers.
startUri string Specify a URL resource that responds with a challenge to a non-authenticated request. Start URI is required if authentication type is basic-ntlm. For Form-Based, a Start URI entry is optional, because you must specify either an absolute or a relative URL resource in the Form Action field. If you specify both parameters, APM uses both of them as the final URL for HTTP POST. If you specify the Form Action parameter only, APM is likely to detect that the absolute URI based on it should be used for HTTP POST. Note for Custom Post authentication type: If you do not specify a Start URI, APM will likely detect that the absolute URI based on the Form Action parameter should be used for HTTP POST. If you specify a Start URI, APM uses both the Start URI and the Form Action parameters as the final URL for HTTP POST.
successMatchType string Specify the method that your authentication server uses and then specify the required information in the successful logon detection match value. Enter the url for match value if the match type is a URL. Enter a string for match value if the match type is string. Enter a cookie for match value if the match type is a cookie. With this match type, when APM receives a duplicate cookie, APM adds it to the existing cookie list. As a result, multiple cookies with the same name, domain, and path can exist. Here is an example, issosession=first; path=/; domain=mycompany.com and issosession=second; path=/; domain= mycompany.com In this case, there are two cookies, and APM searches them both. If exact-cookie is selected as match type, enter the exact key fields (name, path, and domain) that are present in the HTTP response cookie in the Successful Logon Detection Match Value field. To match an HTTP response cookie that contains three key fields, specify all three in the Successful Logon Detection Match Value field, as shown in this example. issosession=value;path=/;domain=mycompanynet.com; To match an HTTP response cookie that contains a subset of the key fields, such as name and path, specify those keys only, as shown in this example: issosession=any;path=/;. Note: Failure to supply the exact number of keys and exact values for the HTTP response cookie results in a No matching cookie found error message. Note: This match type supports cookie merge functionality. When APM receives a cookie with the same name, domain, and path as an existing cookie, APM merges it into the existing cookie. Here are two cookies each with the same name, domain, and path: issosession=first; path=/; domain=mycompany.com issosession=second; path=/; domain= mycompany.com In this case, the second cookie replaces the first cookie.
successMatchValue string Enter the URL, cookie, specific string or exact keys used for the specific Successful logon detection match type you selected.
name string The name of the object
partition string The BIG-IP partition where the object should be placed
subPath string The BIG-IP folder where the object should be placed
lsoDeviceReference reference Reference to the device
     id string Id of the device.
     name string Device name. Typically it is device’s hostname.
     kind string Kind of the device.
     machineId string Machine ID of the device.
     link string URI link of the reference.
isLsoShared boolean Specifies if the location-specific object instance is shared across all devices. Use this only during POST. Warning: Do not flip this flag during PUT/PATCH operations.
deviceGroupReference reference Reference to the device group.
     name string Name of the resource
     kind string The kind of the resource.
     link string URI link of the reference.
id string An ID of an application
kind string The kind of application.
selfLink string The selfLink of an application.

Error Response

HTTP/1.1 400 Bad Request

This response status is related to error conditions. A detailed error message displays in the response.

HTTP/1.1 401 Unauthorized

This response happens when access is denied due to invalid credentials(no Permission).

Permissions

Role Allow
Application_Editor No
Service_Catalog_Viewer No
Service_Catalog_Editor No
Trust_Discovery_Import Yes
Access_View No
Access_Edit Yes
Access_Manager Yes
Application_Manager No
Application_Viewer No
Trust_Discovery_Import No
Access_Deploy No
Access_Policy_Editor No

DELETE /cm/access/working-config/apm/aaa/http/<id>

Request Parameters

None

Query Parameters

None

Response

HTTP/1.1 200 OK

Name Type Description
authType string Specify the authentication Type as Form Based, Basic/NTLM, or Custom Post.Form Based to direct users to a form action URL and to provide the specified form parameters. Use Basic/NTLM to direct users to a URI. Use Custom Post to direct users to either POST URL, a submit URL, or a relative URL and to provide the specified content.
contentType string Specify an encoding for the HTTP custom post. The default setting is XML-UTF8. Note: if you select None, add a header in the Custom Headers fields and apply your own encoding through an iRule.
customBody string Specify the body of the HTTP Custom Post.
followRedirect number Specify the number that indicating how many pages away from the landing page the request can travel before it fails.
formAction string Form Action value is required when Authentication type is form-based or custom-post. For FormBased configuration, Specify the complete destination URL for processing the form. The form action URL specifies where HTTP form-based authentication occurs. If you do not specify a form action, APM uses the URI from the request to perform HTTP form-based authentication. Specify the complete destination URL for processing the form. The form action URL specifies where HTTP form-based authentication occurs. If you do not specify a form action, APM uses the URI from the request to perform HTTP form-based authentication. For Custom Post configuration, enter either the POST URL, submit URL or a relative URL.
formFields string Specify the authentication server logon form at your location. The logon form requires hidden form parameters and values.
formMethod string Specify either GET or POST as form Methods. If you select GET, the authentication request converts to HTTP GET. The default value is post.
formPassword string Specify the parameter password that the form, to which you are sending the POST request, uses.
formUsername string Specify the parameter name that the form, to which you are sending the POST request, uses.
headers array_of_objects Specify the names and values for header content to insert in the HTTP custom post.
     tmName string Name of the header content to insert in the HTTP custom post.
     value string Value of the header content to insert in the HTTP custom post.
     name string Unique name with name and ID that is different then other names and values in the headers.
startUri string Specify a URL resource that responds with a challenge to a non-authenticated request. Start URI is required if authentication type is basic-ntlm. For Form-Based, a Start URI entry is optional, because you must specify either an absolute or a relative URL resource in the Form Action field. If you specify both parameters, APM uses both of them as the final URL for HTTP POST. If you specify the Form Action parameter only, APM is likely to detect that the absolute URI based on it should be used for HTTP POST. Note for Custom Post authentication type: If you do not specify a Start URI, APM will likely detect that the absolute URI based on the Form Action parameter should be used for HTTP POST. If you specify a Start URI, APM uses both the Start URI and the Form Action parameters as the final URL for HTTP POST.
successMatchType string Specify the method that your authentication server uses and then specify the required information in the successful logon detection match value. Enter the url for match value if the match type is a URL. Enter a string for match value if the match type is string. Enter a cookie for match value if the match type is a cookie. With this match type, when APM receives a duplicate cookie, APM adds it to the existing cookie list. As a result, multiple cookies with the same name, domain, and path can exist. Here is an example, issosession=first; path=/; domain=mycompany.com and issosession=second; path=/; domain= mycompany.com In this case, there are two cookies, and APM searches them both. If exact-cookie is selected as match type, enter the exact key fields (name, path, and domain) that are present in the HTTP response cookie in the Successful Logon Detection Match Value field. To match an HTTP response cookie that contains three key fields, specify all three in the Successful Logon Detection Match Value field, as shown in this example. issosession=value;path=/;domain=mycompanynet.com; To match an HTTP response cookie that contains a subset of the key fields, such as name and path, specify those keys only, as shown in this example: issosession=any;path=/;. Note: Failure to supply the exact number of keys and exact values for the HTTP response cookie results in a No matching cookie found error message. Note: This match type supports cookie merge functionality. When APM receives a cookie with the same name, domain, and path as an existing cookie, APM merges it into the existing cookie. Here are two cookies each with the same name, domain, and path: issosession=first; path=/; domain=mycompany.com issosession=second; path=/; domain= mycompany.com In this case, the second cookie replaces the first cookie.
successMatchValue string Enter the URL, cookie, specific string or exact keys used for the specific Successful logon detection match type you selected.
name string The name of the object
partition string The BIG-IP partition where the object should be placed
subPath string The BIG-IP folder where the object should be placed
lsoDeviceReference reference Reference to the device
     id string Id of the device.
     name string Device name. Typically it is device’s hostname.
     kind string Kind of the device.
     machineId string Machine ID of the device.
     link string URI link of the reference.
isLsoShared boolean Specifies if the location-specific object instance is shared across all devices. Use this only during POST. Warning: Do not flip this flag during PUT/PATCH operations.
deviceGroupReference reference Reference to the device group.
     name string Name of the resource
     kind string The kind of the resource.
     link string URI link of the reference.
id string An ID of an application
kind string The kind of application.
selfLink string The selfLink of an application.

Error Response

HTTP/1.1 400 Bad Request

This response status is related to error conditions. A detailed error message displays in the response.

HTTP/1.1 401 Unauthorized

This response happens when access is denied due to invalid credentials(no Permission).

Permissions

Role Allow
Application_Editor No
Service_Catalog_Viewer No
Service_Catalog_Editor No
Trust_Discovery_Import Yes
Access_View No
Access_Edit Yes
Access_Manager Yes
Application_Manager No
Application_Viewer No
Trust_Discovery_Import No
Access_Deploy No
Access_Policy_Editor No

Examples

Get AAA HTTP+ Server

GET /cm/access/working-config/apm/aaa/http/<id>

Response

HTTP/1.1 200 OK
{
    "authType": "form-based",
    "contentType": "xml-utf8",
    "customBody": "User-Agent: HTTPTool/1.0 Content-Type: application/x-www-form-urlencoded Content-Length: 32 home=Cosby&favorite+flavor=flies",
    "followRedirect": 0,
    "formAction": "http://foo.com",
    "formFields": "parameter=value&also=another",
    "formMethod": "post",
    "formPassword": "admin",
    "formUsername": "admin",
    "headers": [{
        "tmName": "Content-Length",
        "value": "3495",
        "name": "name_1"
    }],
    "startUri": "http://www.example.com:8080/main/index.jsp?user=test&login=check",
    "successMatchType": "url",
    "successMatchValue": "http://www.foo.com",
    "name": "foo",
    "partition": "Common",
    "subPath": "/folder",
    "lsoDeviceReference": {
        "id": "866cfd8a-4d03-48e9-ba94-bb21a4bc2346",
        "name": "bigip.foo.com",
        "kind": "shared:resolver:device-groups:restdeviceresolverdevicestate",
        "machineId": "866cfd8a-4d03-48e9-ba94-bb21a4bc2346",
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "isLsoShared": false,
    "deviceGroupReference": {
        "name": "resourceName",
        "kind": "shared:resolver:device-groups:devicegroupstate",
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "id": "8f1fcb69-1f3c-3c0d-812e-af4fdde0ac11",
    "generation": 1,
    "lastUpdateMicros": 1518743088884807,
    "kind": "cm:access:working-config:apm:aaa:active-directory:activedirectorystate",
    "selfLink": "cm:access:working-config:apm:aaa:active-directory:activedirectorystate",
}

Create New AAA HTTP+ Server

POST /cm/access/working-config/apm/aaa/http
{
    "authType": "form-based",
    "contentType": "xml-utf8",
    "customBody": "User-Agent: HTTPTool/1.0 Content-Type: application/x-www-form-urlencoded Content-Length: 32 home=Cosby&favorite+flavor=flies",
    "followRedirect": 0,
    "formAction": "http://foo.com",
    "formFields": "parameter=value&also=another",
    "formMethod": "post",
    "formPassword": "admin",
    "formUsername": "admin",
    "headers": [{
        "tmName": "Content-Length",
        "value": "3495",
        "name": "name_1"
    }],
    "startUri": "http://www.example.com:8080/main/index.jsp?user=test&login=check",
    "successMatchType": "url",
    "successMatchValue": "http://www.foo.com",
    "name": "foo",
    "partition": "Common",
    "subPath": "/folder",
    "lsoDeviceReference": {
        "id": "866cfd8a-4d03-48e9-ba94-bb21a4bc2346",
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "isLsoShared": false,
    "deviceGroupReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
}

Response

HTTP/1.1 200 OK
{
    "authType": "form-based",
    "contentType": "xml-utf8",
    "customBody": "User-Agent: HTTPTool/1.0 Content-Type: application/x-www-form-urlencoded Content-Length: 32 home=Cosby&favorite+flavor=flies",
    "followRedirect": 0,
    "formAction": "http://foo.com",
    "formFields": "parameter=value&also=another",
    "formMethod": "post",
    "formPassword": "admin",
    "formUsername": "admin",
    "headers": [{
        "tmName": "Content-Length",
        "value": "3495",
        "name": "name_1"
    }],
    "startUri": "http://www.example.com:8080/main/index.jsp?user=test&login=check",
    "successMatchType": "url",
    "successMatchValue": "http://www.foo.com",
    "name": "foo",
    "partition": "Common",
    "subPath": "/folder",
    "lsoDeviceReference": {
        "id": "866cfd8a-4d03-48e9-ba94-bb21a4bc2346",
        "name": "bigip.foo.com",
        "kind": "shared:resolver:device-groups:restdeviceresolverdevicestate",
        "machineId": "866cfd8a-4d03-48e9-ba94-bb21a4bc2346",
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "isLsoShared": false,
    "deviceGroupReference": {
        "name": "resourceName",
        "kind": "shared:resolver:device-groups:devicegroupstate",
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "id": "8f1fcb69-1f3c-3c0d-812e-af4fdde0ac11",
    "generation": 1,
    "lastUpdateMicros": 1518743088884807,
    "kind": "cm:access:working-config:apm:aaa:active-directory:activedirectorystate",
    "selfLink": "cm:access:working-config:apm:aaa:active-directory:activedirectorystate",
}

Edit AAA HTTP+ Server

PUT /cm/access/working-config/apm/aaa/http/<id>
{
    "authType": "form-based",
    "contentType": "xml-utf8",
    "customBody": "User-Agent: HTTPTool/1.0 Content-Type: application/x-www-form-urlencoded Content-Length: 32 home=Cosby&favorite+flavor=flies",
    "followRedirect": 0,
    "formAction": "http://foo.com",
    "formFields": "parameter=value&also=another",
    "formMethod": "post",
    "formPassword": "admin",
    "formUsername": "admin",
    "headers": [{
        "tmName": "Content-Length",
        "value": "3495",
        "name": "name_1"
    }],
    "startUri": "http://www.example.com:8080/main/index.jsp?user=test&login=check",
    "successMatchType": "url",
    "successMatchValue": "http://www.foo.com",
    "name": "foo",
    "partition": "Common",
    "subPath": "/folder",
    "lsoDeviceReference": {
        "id": "866cfd8a-4d03-48e9-ba94-bb21a4bc2346",
        "name": "bigip.foo.com",
        "kind": "shared:resolver:device-groups:restdeviceresolverdevicestate",
        "machineId": "866cfd8a-4d03-48e9-ba94-bb21a4bc2346",
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "isLsoShared": false,
    "deviceGroupReference": {
        "name": "resourceName",
        "kind": "shared:resolver:device-groups:devicegroupstate",
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "id": "8f1fcb69-1f3c-3c0d-812e-af4fdde0ac11",
    "generation": 1,
    "lastUpdateMicros": 1518743088884807,
    "kind": "cm:access:working-config:apm:aaa:active-directory:activedirectorystate",
    "selfLink": "cm:access:working-config:apm:aaa:active-directory:activedirectorystate",
}

Response

HTTP/1.1 200 OK
{
    "authType": "form-based",
    "contentType": "xml-utf8",
    "customBody": "User-Agent: HTTPTool/1.0 Content-Type: application/x-www-form-urlencoded Content-Length: 32 home=Cosby&favorite+flavor=flies",
    "followRedirect": 0,
    "formAction": "http://foo.com",
    "formFields": "parameter=value&also=another",
    "formMethod": "post",
    "formPassword": "admin",
    "formUsername": "admin",
    "headers": [{
        "tmName": "Content-Length",
        "value": "3495",
        "name": "name_1"
    }],
    "startUri": "http://www.example.com:8080/main/index.jsp?user=test&login=check",
    "successMatchType": "url",
    "successMatchValue": "http://www.foo.com",
    "name": "foo",
    "partition": "Common",
    "subPath": "/folder",
    "lsoDeviceReference": {
        "id": "866cfd8a-4d03-48e9-ba94-bb21a4bc2346",
        "name": "bigip.foo.com",
        "kind": "shared:resolver:device-groups:restdeviceresolverdevicestate",
        "machineId": "866cfd8a-4d03-48e9-ba94-bb21a4bc2346",
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "isLsoShared": false,
    "deviceGroupReference": {
        "name": "resourceName",
        "kind": "shared:resolver:device-groups:devicegroupstate",
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "id": "8f1fcb69-1f3c-3c0d-812e-af4fdde0ac11",
    "generation": 1,
    "lastUpdateMicros": 1518743088884807,
    "kind": "cm:access:working-config:apm:aaa:active-directory:activedirectorystate",
    "selfLink": "cm:access:working-config:apm:aaa:active-directory:activedirectorystate",
}

Edit AAA HTTP+ Server

PATCH /cm/access/working-config/apm/aaa/http/<id>
{
    "authType": "form-based",
    "contentType": "xml-utf8",
    "customBody": "User-Agent: HTTPTool/1.0 Content-Type: application/x-www-form-urlencoded Content-Length: 32 home=Cosby&favorite+flavor=flies",
    "followRedirect": 0,
    "formAction": "http://foo.com",
    "formFields": "parameter=value&also=another",
    "formMethod": "post",
    "formPassword": "admin",
    "formUsername": "admin",
    "headers": [{
        "tmName": "Content-Length",
        "value": "3495",
        "name": "name_1"
    }],
    "startUri": "http://www.example.com:8080/main/index.jsp?user=test&login=check",
    "successMatchType": "url",
    "successMatchValue": "http://www.foo.com",
    "isLsoShared": false,
}

Response

HTTP/1.1 200 OK
{
    "authType": "form-based",
    "contentType": "xml-utf8",
    "customBody": "User-Agent: HTTPTool/1.0 Content-Type: application/x-www-form-urlencoded Content-Length: 32 home=Cosby&favorite+flavor=flies",
    "followRedirect": 0,
    "formAction": "http://foo.com",
    "formFields": "parameter=value&also=another",
    "formMethod": "post",
    "formPassword": "admin",
    "formUsername": "admin",
    "headers": [{
        "tmName": "Content-Length",
        "value": "3495",
        "name": "name_1"
    }],
    "startUri": "http://www.example.com:8080/main/index.jsp?user=test&login=check",
    "successMatchType": "url",
    "successMatchValue": "http://www.foo.com",
    "name": "foo",
    "partition": "Common",
    "subPath": "/folder",
    "lsoDeviceReference": {
        "id": "866cfd8a-4d03-48e9-ba94-bb21a4bc2346",
        "name": "bigip.foo.com",
        "kind": "shared:resolver:device-groups:restdeviceresolverdevicestate",
        "machineId": "866cfd8a-4d03-48e9-ba94-bb21a4bc2346",
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "isLsoShared": false,
    "deviceGroupReference": {
        "name": "resourceName",
        "kind": "shared:resolver:device-groups:devicegroupstate",
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "id": "8f1fcb69-1f3c-3c0d-812e-af4fdde0ac11",
    "generation": 1,
    "lastUpdateMicros": 1518743088884807,
    "kind": "cm:access:working-config:apm:aaa:active-directory:activedirectorystate",
    "selfLink": "cm:access:working-config:apm:aaa:active-directory:activedirectorystate",
}

Delete AAA HTTP+ Server

DELETE /cm/access/working-config/apm/aaa/http/<id>

Response

HTTP/1.1 200 OK
{
    "authType": "form-based",
    "contentType": "xml-utf8",
    "customBody": "User-Agent: HTTPTool/1.0 Content-Type: application/x-www-form-urlencoded Content-Length: 32 home=Cosby&favorite+flavor=flies",
    "followRedirect": 0,
    "formAction": "http://foo.com",
    "formFields": "parameter=value&also=another",
    "formMethod": "post",
    "formPassword": "admin",
    "formUsername": "admin",
    "headers": [{
        "tmName": "Content-Length",
        "value": "3495",
        "name": "name_1"
    }],
    "startUri": "http://www.example.com:8080/main/index.jsp?user=test&login=check",
    "successMatchType": "url",
    "successMatchValue": "http://www.foo.com",
    "name": "foo",
    "partition": "Common",
    "subPath": "/folder",
    "lsoDeviceReference": {
        "id": "866cfd8a-4d03-48e9-ba94-bb21a4bc2346",
        "name": "bigip.foo.com",
        "kind": "shared:resolver:device-groups:restdeviceresolverdevicestate",
        "machineId": "866cfd8a-4d03-48e9-ba94-bb21a4bc2346",
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "isLsoShared": false,
    "deviceGroupReference": {
        "name": "resourceName",
        "kind": "shared:resolver:device-groups:devicegroupstate",
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "id": "8f1fcb69-1f3c-3c0d-812e-af4fdde0ac11",
    "generation": 1,
    "lastUpdateMicros": 1518743088884807,
    "kind": "cm:access:working-config:apm:aaa:active-directory:activedirectorystate",
    "selfLink": "cm:access:working-config:apm:aaa:active-directory:activedirectorystate",
}
Previous Next