community.general.online_user_info (8.5.0) — module

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

Gather information about the user.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Gather Online user info
  community.general.online_user_info:
  register: result

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- ansible.builtin.debug:
    msg: "{{ result.online_user_info }}"

Inputs

    
api_url:
    aliases:
    - base_url
    default: https://api.online.net
    description:
    - Online API URL.
    type: str

api_token:
    aliases:
    - oauth_token
    description:
    - Online OAuth token.
    required: true
    type: str

api_timeout:
    aliases:
    - timeout
    default: 30
    description:
    - HTTP timeout to Online API in seconds.
    type: int

validate_certs:
    default: true
    description:
    - Validate SSL certs of the Online API.
    type: bool

Outputs

online_user_info:
  description:
  - Response from Online API.
  - 'For more details please refer to: U(https://console.online.net/en/api/).'
  returned: success
  sample:
    online_user_info:
      company: foobar LLC
      email: foobar@example.com
      first_name: foo
      id: 42
      last_name: bar
      login: foobar
  type: dict