google.cloud.gcp_iam_service_account – Creates a GCP ServiceAccount
Note
This plugin is part of the google.cloud collection (version 1.0.2).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install google.cloud.
To use it in a playbook, specify: google.cloud.gcp_iam_service_account.
Synopsis
- A service account in the Identity and Access Management API.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| auth_kind
string / required
|
|
The type of credential used.
|
| display_name
string
|
User specified description of service account.
|
|
| env_type
string
|
Specifies which Ansible environment you're running this module within.
This should not be set unless you know what you're doing.
This only alters the User Agent string for any API requests.
|
|
| name
string
|
The name of the service account.
|
|
| project
string
|
The Google Cloud Platform project to use.
|
|
| scopes
list / elements=string
|
Array of scopes to be used
|
|
| service_account_contents
jsonarg
|
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.
|
|
| service_account_email
string
|
An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
|
|
| service_account_file
path
|
The path of a Service Account JSON file if serviceaccount is selected as type.
|
|
| state
string
|
|
Whether the given object should exist in GCP
|
Examples
- name: create a service account
google.cloud.gcp_iam_service_account:
name: sa-{{ resource_name.split("-")[-1] }}@graphite-playground.google.com.iam.gserviceaccount.com
display_name: My Ansible test key
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| displayName
string
|
success |
User specified description of service account.
|
| email
string
|
success |
Email address of the service account.
|
| name
string
|
success |
The name of the service account.
|
| oauth2ClientId
string
|
success |
OAuth2 client id for the service account.
|
| projectId
string
|
success |
Id of the project that owns the service account.
|
| uniqueId
string
|
success |
Unique and stable id of the service account.
|
Authors
- Google Inc. (@googlecloudplatform)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_iam_service_account_module.html