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.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
boolean
|
|
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: 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"] }
Hint
If you notice any issues in this documentation you can edit this document to improve it.