cp_mgmt_idp_administrator_group
Manages idp-administrator-group objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions
Collection: check_point.mgmt
Full Name: check_point.mgmt.cp_mgmt_idp_administrator_group
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Manages idp-administrator-group objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| auto_publish_session | bool | false | Publish this owned session explicitly after the operation; default false. | |
| color | str | Color of the object. Should be one of existing colors. | ||
| comments | str | Comments string. | ||
| details_level | str | 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. | ||
| group_id | str | Group ID or Name should be set base on the source attribute of ‘groups’ in the Saml Assertion. | ||
| ignore_errors | bool | 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. | ||
| ignore_warnings | bool | Apply changes ignoring warnings. | ||
| multi_domain_profile | str | Administrator multi-domain profile. | ||
| name | str | yes | Object name. | |
| permissions_profile | list | Administrator permissions profile. Permissions profile should not be provided when multi-domain-profile is set to “Multi-Domain Super User” or “Domain Super User”. | ||
| state | str | present | Desired object presence. | |
| tags | list | Collection of tag identifiers. | ||
| version | str | Management API version path; omitted uses the default API version. | ||
| wait_for_task | bool | true | Wait for returned asynchronous task identifiers; default true. | |
| wait_for_task_timeout | int | 30 | Polling deadline in minutes; default 30, negative values use 30, maximum 1440. |
Example
yaml
- name: add-idp-administrator-group
check_point.mgmt.cp_mgmt_idp_administrator_group:
group_id: it-team
multi_domain_profile: domain super user
name: my super group
state: present
- name: set-idp-administrator-group
check_point.mgmt.cp_mgmt_idp_administrator_group:
group_id: global-domain-checkpoint
name: my global group
state: present
- name: delete-idp-administrator-group
check_point.mgmt.cp_mgmt_idp_administrator_group:
name: my super group
state: absent