apm policy agent api-authentication

apm policy agent api-authentication(1)			BIG-IP TMSH Manual		    apm policy agent api-authentication(1)

NAME
       api-authentication - Manages API Authentication agent.

MODULE
       apm policy agent

SYNTAX
       Configure the api-authentication component within the policy agent module using the syntax shown in the following sections.

   CREATE/MODIFY
	create api-authentication [name]
	modify api-authentication [name]
	  options:
	    app-service [[string] | none]

	edit api-authentication [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    all-properties
	    non-default-properties

   DISPLAY
	list api-authentication
	list api-authentication [ [ [name] | [glob] | [regex] ] ... ]
	show running-config api-authentication
	show running-config api-authentication	[ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    all-properties
	    non-default-properties
	    partition

	show api-authentication
	show api-authentication [name]

   DELETE
	delete api-authentication [name]

DESCRIPTION
       You can use the api-authentication component to create an API Authentication agent to inspect authentication header in the
       request and set appropriate sub-session variable.

EXAMPLES
       create api-authentication my_api_authentication_agent
	    Creates the my_api_authentication_agent API Authentication agent.

       list api-authentication
	    Displays a list of API Authentication agents.

       delete api-authentication my_api_authentication_agent
	    Deletes the API Authentication agent named my_api_authentication_agent.

OPTIONS
       [name]
	    Specifies the name of a API Authentication agent. This option is required.

       partition
	    Displays the partition within which the component resides.

       app-service
	    Specifies the name of the application service to which the object belongs. The default value is none. Note: If the
	    strict-updates option is enabled on the application service that owns the object, you cannot modify or delete the
	    object. Only the application service can modify or delete the object.

SEE ALSO
       api-protection

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 2018. All rights reserved.

BIG-IP							    2018-07-13			    apm policy agent api-authentication(1)