syntropynet.syntropy.syntropy_api_key (0.3.0) — module

Install collection

Install with ansible-galaxy collection install syntropynet.syntropy:==0.3.0

Add to requirements.yml

  collections:
    - name: syntropynet.syntropy
      version: 0.3.0

Description

API Keys are being used by the Syntropy Agent that is run on each endpoint.

These keys are being used to communicate with the Syntropy platform.

Requirements

• syntropy-sdk

Usage examples

Scanned by Steampunk Spotter

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

-   name: Create a new API key
    syntropy_api_key:
        name: my-api-key
        suspend: no
        state: present
    register: api_key

Scanned by Steampunk Spotter

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

-   name: Delete an API key
    syntropy_api_key:
        name: my-api-key
        state: absent

Inputs

    
name:
    description: API Key name.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description: A desired state of the API key.
    required: false
    type: str

api_url:
    default: null
    description:
    - URL Of the Platform API.
    - This parameter is required if SYNTROPY_API_SERVER environment variable is not set.
    required: false
    type: str

expires:
    default: null
    description:
    - ISO formatted API key expiration datetime.
    - If expires is null, then current day-time + 30 days will be used as expiration date.
    required: false
    type: str

suspend:
    default: false
    description: Indicate whether the API Key is suspended.
    required: false
    type: bool

api_token:
    default: null
    description:
    - API Authorization token string.
    - This parameter is required if SYNTROPY_API_TOKEN environment variable is not set.
    required: false
    type: str

Outputs

api_key:
  description: Retrieved API key upon successful login.
  returned: always
  sample:
    api_key_id: 0
    api_key_is_suspended: true
    api_key_name: string
    api_key_secret: string
    api_key_valid_until: string
    organization_id: 0
    user_id: 0
  type: dict
error:
  description: Error message upon unsuccessful API key creation.
  returned: always
  sample: Syntropy API call resulted in an error
  type: str