heroku_collaborator – Add or delete app collaborators on Heroku¶
New in version 2.6.
Synopsis¶
Manages collaborators for Heroku apps.
If set to
presentand heroku user is already collaborator, then do nothing.If set to
presentand heroku user is not collaborator, then add user to app.If set to
absentand heroku user is collaborator, then delete user from app.
Parameters¶
Notes¶
Note
HEROKU_API_KEYandTF_VAR_HEROKU_API_KEYenv variable can be used instead setting c(api_key).If you use –check, you can also pass the -v flag to see affected apps in
msg, e.g. [“heroku-example-app”].
Examples¶
- heroku_collaborator:
api_key: YOUR_API_KEY
user: max.mustermann@example.com
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: 'a.b@example.com' }
- { state: 'absent', user: 'b.c@example.com', suppress_invitation: false }
- { user: 'x.y@example.com', apps: ["heroku-example-app"] }
Status¶
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]
Authors¶
Marcel Arns (@marns93)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.