PARALLAX

cp_mgmt_set_idp_to_domain_assignment

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 through native controller HTTPAPI with owned sessions

Collection: check_point.mgmt

Full Name: check_point.mgmt.cp_mgmt_set_idp_to_domain_assignment

Controller module — runs on the local controller, not on remote hosts.

Synopsis

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 through native controller HTTPAPI with owned sessions

Parameters

NameTypeRequiredDefaultDescription
assigned_domainstrRepresents the Domain assigned by ‘idp-to-domain-assignment’, need to be domain name or UID.
auto_publish_sessionboolfalsePublish the current session if changes have been performed after task completes.
details_levelstrThe 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.
identity_providerstrRepresents the Identity Provider to be used for Login by this assignment. Must be set when “using-default” was set to be false.
ignore_errorsboolApply changes ignoring errors. You won’t be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
ignore_warningsboolApply changes ignoring warnings.
using_defaultboolIs this assignment override by ‘idp-default-assignment’.
versionstrManagement API version path; omitted uses the default API version.
wait_for_taskbooltrueWait for returned asynchronous task identifiers; default true.
wait_for_task_timeoutint30Polling deadline in minutes; default 30, negative values use 30, maximum 1440.

Example

yaml
- name: set-idp-to-domain-assignment
  check_point.mgmt.cp_mgmt_set_idp_to_domain_assignment:
    assigned_domain: BSMS
    identity_provider: okta
Search
    ↑ ↓ move↵ openesc close