Virtual server traffic Authentication profile configuration

REST Endpoints

Collection URI
Collection Methods
Resource URI
/mgmt/tm/ltm/auth/profile/~resource id
Resource Methods
Resource Natural Key
name, partition, subPath


Name Type Default Value Required Access Description
appService string   optional read/write The application service to which the object belongs.
null string   optional read  
configuration string   optional read/write Specifies the name of a previously created authentication component. This setting is required.
cookieKey string abc123 optional read/write Specifies the key that is used to encrypt the cookie-name. The default value is “f5auth”. This setting applies to KRB Delegate profiles.
cookieName string f5auth optional read/write Specifies a unique session cookie assigned to each user. Each virtual server should use a different cookie name. The cookie-name is encrypted using the cookie-key. The default value is “abc123”. This setting applies to KRB Delegate profiles.
credentialSource string http-basic-auth optional read/write Specifies the credential source.
defaultsFrom string   required read/write Specifies the name of the default authentication profile from which you want your custom profile to inherit settings. This setting is required.
description string   optional read/write User defined description.
enabled string yes optional read/write Specifies whether the authentication profile is enabled. The default value is yes.
fileName string   optional read/write  
idleTimeout integer 300 optional read/write Sets the idle timeout for the authentication profile. The default value is 300 seconds.
tmPartition string Common optional read/write Displays the administrative partition within which this component resides.
rule string   optional read/write Specifies the name of the rule that corresponds to the authentication method you want to use with this profile.
type string   optional read/write  
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.