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