apm aaa http-connector-request

apm aaa http-connector-request(1)			BIG-IP TMSH Manual			 apm aaa http-connector-request(1)

NAME
       http-connector-request - Stores the configuration for a HTTP Request.

MODULE
       apm aaa

SYNTAX
       Configure the http-connector-request object within the aaa module using the syntax shown in the following sections.

   CREATE/MODIFY
	create/modify http-connector-request [name]
	   options:
	    method [string]
	    url [string]
	    transport [name]
	    auth [none | basic | bearer | custom]
	    username [[string] | none]
	    password [[string] | none]
	    token [[string] | none]
	    request-headers [[string] | none]
	    request-body [[string] | none]
	    response-action [parse | save | ignore]
	    secure-variables [add | delete | replace-all-with] [[vector-string] | none]
	    response-headers [[string] | none]

	edit http-connector-request [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    all-properties
	    non-default-properties

   DISPLAY
	list http-connector-request
	list http-connector-request [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    all-properties
	    app-service
	    non-default-properties
	    one-line
	    partition

   DELETE
	delete http-connector-request [name]

DESCRIPTION
       You can use the http-connector-request to send HTTP Request to any Endpoint.

EXAMPLES
       create http-connector-request PostRequest { method POST	url "https://server01.company.com?id=%{subsession.mdm.device_id}"
       transport "your-http-connector-transport" auth bearer token some-token response-action ignore }
	    Creates the HTTP Connector Request Object named PostRequest with HTTP method POST, sets the URL to
	    https://server01.company.com?id=%{subsession.mdm.device_id}, sets transport to your-http-connector-transport, sets the
	    Authentication Type to bearer and the token to some_token, and sets the Response Action to ignore.

       delete http-connector-request PostRequest
	    Deletes the HTTP Connector Request Object named PostRequest from the system.

OPTIONS
       name Specifies the name for the HTTP Connector Request Object. This setting is required.

       method
	    Specifies the method for http request, e.g. GET, POST, PUT etc. This setting is required.

       url  Specifies the url of the endpoint. This setting is required. Sub-session variables can be specified,
	    %{subsession.variable_name}.

       transport
	    Specifies the HTTP Connector Transport object. This setting is required.

       auth Specifies the Authentication type. The default value is none. If custom is selected, then the username, password and
	    token fields can be used in url, request-headers, or request-body with standard placeholders for them e.g.
	    %{password}, %{username} or %{token}. Along with this special place holder %{basic_auth} can be used to insert value
	    "Basic base64_encoded_value[some-username:some-password]" where "some-username" and "some-password" is specified in
	    username and password field.

       username
	    Specifies the user name. This field can be used in url, request-headers or request-body with placeholder %{username}
	    if Authentication type is custom.

       password
	    Specifies the password. This field can be used in url, request-headers or request-body with placeholder %{password} if
	    Authentication type is custom.

       token
	    Specifies the token. This field can be used in url, request-headers or request-body with placeholder %{token} if
	    Authentication type is custom.

       request-headers
	    Specifies the request headers. Each header needs to be specified on a new-line. There is no easy way to specify new-
	    line separating the headers if creating the object through tmsh. Since this is not a required field, one can create
	    the HTTP query without this field and then use edit command on the created object to specify the headers each
	    separated through new-line. Sub-session variables can be specified, %{subsession.variable_name}.

       request-body
	    Specifies the request body. Sub-session variables can be specified, %{subsession.variable_name}.

       response-action
	    Specifies how response data is processed. Action 'parse' should be selected only if the response is in JSON format.
	    'save' will save the entire response data in a single subsession variable. 'ignore' will not save the response.

       secure-variables
	    Specifies the data which needs to be secured in the response body. This field comes into effect when the response is
	    in JSON format, and response-action have been set to parse. The full path to secure each node must be specified. If
	    the response is {"node1": {"node2": "value"}}, then the full path is node1.node2. If any variable specified in the
	    secure-variables field is not found in the response body, it will be treated as an error, and the http-connector agent
	    will follow fallback path.

       response-headers
	    Specifies the response headers that needs to saved as subsession variables. These are "," separated values. If it is
	    empty, then response headers are ignored.

SEE ALSO
COPYRIGHT
       No part of this program may be reproduced or transmitted in any form or by any means, electronic or mechanical, including
       photocopying, recording, or information storage and retrieval systems, for any purpose other than the purchaser's personal
       use, without the express written permission of F5 Networks, Inc.

       F5 Networks and BIG-IP (c) Copyright 2011-2015. All rights reserved.

BIG-IP							    2020-10-07				 apm aaa http-connector-request(1)