.. _a10_aam_authentication_oauth_client_module:


a10_aam_authentication_oauth_client
===================================

.. contents::
   :local:
   :depth: 1


Synopsis
--------

Authentication 2.0 Oauth client






Parameters
----------

 
| Parameters             | Choices/Defaults              | Comment                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| state                  | ['noop', 'present', 'absent'] | State of the object to be created.                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str/required           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| ansible_host           |                               | Host for AXAPI authentication                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str/required           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| ansible_username       |                               | Username for AXAPI authentication                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str/required           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| ansible_password       |                               | Password for AXAPI authentication                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str/required           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| ansible_port           |                               | Port for AXAPI authentication                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| int/required           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| a10_device_context_id  | ['1-8']                       | Device ID for aVCS configuration                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| int                    |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| a10_partition          |                               | Destination/target partition for object/command                                                                                                                                                                                                                                                                                                                                                                                                                             |
|                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str                    |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| name                   |                               | Specify client object name                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str/required           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| parameter_nonce_enable |                               | Enable nonce parameter for authorization and token request                                                                                                                                                                                                                                                                                                                                                                                                                  |
|                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| bool                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| no_reply               |                               | AX will not check the nonce value in response                                                                                                                                                                                                                                                                                                                                                                                                                               |
|                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| bool                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| token_lifetime         |                               | Field token_lifetime                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| int                    |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| infinity               |                               | Auth session never time out whatever value oauth servers' response                                                                                                                                                                                                                                                                                                                                                                                                          |
|                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| bool                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| client_id              |                               | Specify oauth client-id                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str                    |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| client_secret          |                               | Field client_secret                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str                    |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| encrypted              |                               | Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)                                                                                                                                                                                                                                                                                                                                                                           |
|                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str                    |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| ntype                  |                               | 'openid-connect'= openid-connect;                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str                    |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| grant_type             |                               | 'implicit'= The authorization server will return access token directly.; 'authorization-code'= The authorization server will respond with code which can be exchange for access token.; 'hybrid-code-id-token'= The authorization server will respond with both code and id token.; 'hybrid-code-token'= The authorization server will respond with both code and access token.; 'hybrid- all'= The authorization server will respond with code, access token and id token; |
|                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str                    |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| redirection_endpoint   |                               | Oauth client redirection endpoint service URL.                                                                                                                                                                                                                                                                                                                                                                                                                              |
|                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str                    |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| session_init_ttl       |                               | TTL for Thunder to wait for first response from authorization server                                                                                                                                                                                                                                                                                                                                                                                                        |
|                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| int                    |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| scope                  |                               | Specify request scope parameters (e.g. profile email address phone)                                                                                                                                                                                                                                                                                                                                                                                                         |
|                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str                    |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| uuid                   |                               | uuid of the object                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str                    |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| user_tag               |                               | Customized tag                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str                    |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 







Examples
--------

.. code-block:: yaml+jinja

    



Return Values
-------------

modified_values (changed, dict, )
  Values modified (or potential changes if using check_mode) as a result of task operation


axapi_calls (always, list, )
  Sequential list of AXAPI calls made by the task


  endpoint (, str, ['/axapi/v3/slb/virtual_server', '/axapi/v3/file/ssl-cert'])
    The AXAPI endpoint being accessed.


  http_method (, str, ['POST', 'GET'])
    HTTP method being used by the primary task to interact with the AXAPI endpoint.


  request_body (, complex, )
    Params used to query the AXAPI


  response_body (, complex, )
    Response from the AXAPI






Status
------




- This module is not guaranteed to have a backwards compatible interface. *[preview]*


- This module is maintained by community.



Authors
~~~~~~~

- A10 Networks

