pureport.pureport.access_token_info (0.0.9) — module

Install collection

Install with ansible-galaxy collection install pureport.pureport:==0.0.9

Add to requirements.yml

  collections:
    - name: pureport.pureport
      version: 0.0.9

Description

Retrieve an access token to use with the Pureport API

Requirements

• pureport-client

Usage examples

Scanned by Steampunk Spotter

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

- name: Retrieve the access token for an api key and secret
  access_token_info:
    api_key: XXXXXXXXXXXXX
    api_secret: XXXXXXXXXXXXXXXXX
  register: result   # Registers result.access_token

Scanned by Steampunk Spotter

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

- name: Set the access token as a fact
  set_fact:
    access_token: result.access_token

Inputs

    
api_key:
    description:
    - The pre-configured API Key for a Pureport Account.
    required: true
    type: str

api_secret:
    description:
    - The pre-configured API Secret for a Pureport Account.
    required: true
    type: str

api_base_url:
    description:
    - The host url for the Pureport API.
    required: false
    type: str

Outputs

access_token:
  description:
  - An access token that can be used with other Pureport facts.
  returned: success
  type: str