check_point.mgmt.cp_mgmt_set_idp_to_domain_assignment (5.2.3) — module

Set Identity Provider assignment to domain, to allow administrator login to that domain using that identity provider, if there is no Identity Provider assigned to the domain the 'idp-default-assignment' will be used. This command only available for Multi-Domain server.

| "added in version" 3.0.0 of check_point.mgmt"

Authors: Eden Brillant (@chkp-edenbr)

preview | supported by community

Install collection

Install with ansible-galaxy collection install check_point.mgmt:==5.2.3


Add to requirements.yml

  collections:
    - name: check_point.mgmt
      version: 5.2.3

Description

Set Identity Provider assignment to domain, to allow administrator login to that domain using that identity provider, if there is no Identity Provider assigned to the domain the 'idp-default-assignment' will be used. This command only available for Multi-Domain server.

All operations are performed over Web Services API.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: set-idp-to-domain-assignment
  cp_mgmt_set_idp_to_domain_assignment:
    assigned_domain: BSMS
    identity_provider: okta

Inputs

    
version:
    description:
    - Version of checkpoint. If not given one, the latest version taken.
    type: str

details_level:
    choices:
    - uid
    - standard
    - full
    description:
    - The level of detail for some of the fields in the response can vary from showing
      only the UID value of the object to a fully detailed representation of the object.
    type: str

ignore_errors:
    description:
    - Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings
      flag was omitted - warnings will also be ignored.
    type: bool

using_default:
    description:
    - Is this assignment override by 'idp-default-assignment'.
    type: bool

wait_for_task:
    default: true
    description:
    - Wait for the task to end. Such as publish task.
    type: bool

assigned_domain:
    description:
    - Represents the Domain assigned by 'idp-to-domain-assignment', need to be domain
      name or UID.
    type: str

ignore_warnings:
    description:
    - Apply changes ignoring warnings.
    type: bool

identity_provider:
    description:
    - Represents the Identity Provider to be used for Login by this assignment. Must be
      set when "using-default" was set to be false.
    type: str

auto_publish_session:
    default: false
    description:
    - Publish the current session if changes have been performed after task completes.
    type: bool

wait_for_task_timeout:
    default: 30
    description:
    - How many minutes to wait until throwing a timeout error.
    type: int

Outputs

cp_mgmt_set_idp_to_domain_assignment:
  description: The checkpoint set-idp-to-domain-assignment output.
  returned: always.
  type: dict