New in version 2.6.
present
and heroku user is already collaborator, then do nothing.present
and heroku user is not collaborator, then add user to app.absent
and heroku user is collaborator, then delete user from app.The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
api_key | Heroku API key | |
apps required | List of Heroku App names | |
state |
| Create or remove the heroku collaborator |
suppress_invitation bool |
| Suppress email invitation when creating collaborator |
user required | User ID or e-mail |
Note
HEROKU_API_KEY
and TF_VAR_HEROKU_API_KEY
env variable can be used instead setting c(api_key).msg
, e.g. [“heroku-example-app”].- heroku_collaborator: api_key: YOUR_API_KEY user: [email protected] apps: heroku-example-app state: present - heroku_collaborator: api_key: YOUR_API_KEY user: '{{ item.user }}' apps: '{{ item.apps | default(apps) }}' suppress_invitation: '{{ item.suppress_invitation | default(suppress_invitation) }}' state: '{{ item.state | default("present") }}' with_items: - { user: '[email protected]' } - { state: 'absent', user: '[email protected]', suppress_invitation: false } - { user: '[email protected]', apps: ["heroku-example-app"] }
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/heroku_collaborator_module.html