Actions38
- APM Actions
- ASM Actions
- Authentication Actions
- LTM Actions
- System Actions
Authentication → Request Token
AI-generatedSummary
Authenticates against a BIG-IP via iControl REST by POSTing a username, password and login provider to /mgmt/shared/authn/login, returning the API's login response, which contains an auth token.
Inputs
- Username (required) — BIG-IP username to authenticate as. Sent as
usernamein the request body. - Password (required) — Password for the BIG-IP user. Sent as
passwordin the request body. - Login Provider Name — Authentication provider, sent as
loginProviderName. Defaults totmos(local auth); use an LDAP or RADIUS provider name for external auth. - Request Options — Optional node settings: batching (items per batch and interval in ms), ignore SSL issues, HTTP proxy URL, and request timeout in ms (default 10000).
Output shape
One JSON response per input item from the BIG-IP login endpoint, which includes the issued token details.
The source doesn't transform the response. The shape is whatever iControl REST returns, typically a token object with its value and expiry. The node applies the configured host URL from the bigIpF5Api credential, and the credential is required. The request body is built from the declared parameters only, and the returned token isn't automatically applied to later nodes. Pass it on yourself, for example as an X-F5-Auth-Token header.
Examples
Example 1: Get a token using a local BIG-IP account before calling other iControl REST endpoints.
Resource: Authentication; Operation: Request Token; Username: admin; Password: (secret); Login Provider Name: tmos.
Example 2: Authenticate a user managed by an LDAP provider.
Resource: Authentication; Operation: Request Token; Username and Password set from the LDAP account; Login Provider Name: the LDAP provider's name on the BIG-IP.
Example 3: Log in to a lab device with a self-signed certificate.
Resource: Authentication; Operation: Request Token; credentials filled in; Request Options > Ignore SSL Issues (Insecure): on.