> [!CAUTION]
> You are currently viewing version 1.2 of the Apigee hybrid documentation. **This version is end of life.** You should upgrade to a newer version. For more information, see [Supported versions](https://docs.cloud.google.com/apigee/docs/hybrid/supported-platforms.md.txt#supported-versions).

<button class="button button-with-icon cloud-select-dropdown__button button-primary" aria-haspopup="true">Version 1.2 (unsupported)</button>

- Supported versions:
- [v1.17 (latest)](https://docs.cloud.google.com/apigee/docs/hybrid/v1.17/create-service-account.md.txt)
- [v1.16](https://docs.cloud.google.com/apigee/docs/hybrid/v1.16/create-service-account.md.txt)
- [v1.15](https://docs.cloud.google.com/apigee/docs/hybrid/v1.15/create-service-account.md.txt)
- [v1.14](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/create-service-account.md.txt)
- [List of supported versions](https://docs.cloud.google.com/apigee/docs/hybrid/supported-platforms.md.txt#supported-versions)
- Unsupported versions:
- [v1.13](https://docs.cloud.google.com/apigee/docs/hybrid/v1.13/create-service-account.md.txt)
- [v1.12](https://docs.cloud.google.com/apigee/docs/hybrid/v1.12/create-service-account.md.txt)
- [v1.11](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/create-service-account.md.txt)
- [v1.10](https://docs.cloud.google.com/apigee/docs/hybrid/v1.10/create-service-account.md.txt)
- [v1.9](https://docs.cloud.google.com/apigee/docs/hybrid/v1.9/create-service-account.md.txt)
- [v1.8](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/create-service-account.md.txt)
- [v1.7](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/create-service-account.md.txt)
- [v1.6](https://docs.cloud.google.com/apigee/docs/hybrid/v1.6/create-service-account.md.txt)
- [v1.5](https://docs.cloud.google.com/apigee/docs/hybrid/v1.5/create-service-account.md.txt)
- [v1.4](https://docs.cloud.google.com/apigee/docs/hybrid/v1.4/create-service-account.md.txt)
- [v1.3](https://docs.cloud.google.com/apigee/docs/hybrid/v1.3/create-service-account.md.txt)
- [v1.2](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/create-service-account.md.txt)
- [v1.1](https://docs.cloud.google.com/apigee/docs/hybrid/v1.1/create-service-account.html)

Creates Google Cloud Platform (GCP) service accounts with roles that allow
individual Apigee hybrid components to make authorized API calls and downloads
the associated service account key files. You can use
the service account key files generated by this command in your configuration overrides file.

The `create-service-account` tool is located in
`hybrid_root_dir/tools` directory.

## Prerequisites

The `create-service-account` tool requires that the [gcloud](https://cloud.google.com/sdk/gcloud/) CLI be
installed. Users invoking the utility should have the role `Service Account Admin`.

To get started, be sure your `gcloud` project
configuration is set to the project you created in [Step 2: Create a Google Cloud project](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/precog-gcpproject.md.txt):

```
gcloud config list project
```


If you need to change the current project ID, use this command:

```
gcloud config set project gcp_project_id
```

Where <var translate="no">gcp_project_id</var> is the project created in [Step 2: Create a Google Cloud project](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/precog-gcpproject.md.txt).

## create-service-account syntax

The `create-service-account` tool uses the following syntax:

```
create-service-account component_name output_dir [gcp_project_id]
```

Where:

- <var translate="no">component_name</var>: Specifies the hybrid service that uses the service account. Valid values are:
  - `apigee-cassandra`
  - `apigee-logger`
  - `apigee-mart`
  - `apigee-metrics`
  - `apigee-synchronizer`
  - `apigee-udca`

  Note that the `create-service-account` tool cannot create the
  `apigee-org-admin` service account. You must create that either with the
  GCP or gCloud APIs, as described in [Create service accounts](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/install-download-install.md.txt#create-service-accounts).
- <var translate="no">output_dir</var>: The output directory in which to store the downloaded service account key.
- <var translate="no">gcp_project_id</var>: (Optional) Specifies the GCP project ID of the project that is bound to your hybrid-enabled organization. If the GCP project ID is not provided, the tool attempts to retrieve it from the current gcloud configuration.

> [!NOTE]
> **NOTE:** When you generate a service account for `apigee-mart` you'll see this error:
>
> ```
> [ERROR]: No roles found for component apigee-mart
> ```
>
> You can ignore the error---the service account for MART does not need a role and is created
> with no role assigned to it.

## Detailed description

The `create-service-account` tool:

- Creates [GCP service accounts](https://cloud.google.com/iam/docs/service-accounts) used by hybrid components. The created service account is granted the role required by the specific component to operate.
- Downloads the service account key to your system. You place the service account keys in your hybrid configuration overrides file, as explained in the hybrid [installation instructions](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/install-before-begin.md.txt).

The tool creates service accounts for the following components:

| Component^\*^ | Role | Required for basic install? | Description |
|---|---|---|---|
| `apigee-cassandra` | Storage Object Admin | Yes | Allows Cassandra backups to Google Cloud Storage, as described in [Backup and recovery](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/backup-recovery.md.txt). |
| `apigee-logger` | Logs Writer | No | Allows logging data collection, as described in [Logging](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/logging.md.txt). Only required for non-GKE cluster installations. |
| `apigee-mart` | *No role* | Yes | Allows MART service authentication. This service account should not have a role associated with it; as a result, when you create this service account, do not assign a role to it. |
| `apigee-metrics` | Monitoring Metric Writer | No | Allows metrics data collection, as described in [Metrics collection](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/metrics-collection.md.txt) |
| `apigee-org-admin` | Apigee Organization Admin | Yes | Lets you call the [getSyncAuthorization API](https://docs.cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations/getSyncAuthorization.md.txt) and [setSyncAuthorization API](https://docs.cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations/setSyncAuthorization.md.txt). You cannot create this service account with the `create-service-account` tool. |
| `apigee-synchronizer` | Apigee Synchronizer Manager | Yes | Allows the synchronizer to download proxy bundles and environment configuration data. Also enables operation of the trace feature. |
| `apigee-udca` | Apigee Analytics Agent | Yes | Allows the transfer of trace, analytics and deployment status data to the management plane. |
| ^\*^ This name is used in the downloaded service account key's filename. ||||

You can also create service accounts in the GCP Console. See also
[Creating
and managing service accounts](https://cloud.google.com/iam/docs/creating-managing-service-accounts).

## Example

The following example creates a new service account for the `apigee-logger`
service and places the downloaded key in the `./service-accounts` directory.

```
./my-hybrid-root/tools/create-service-account apigee-logger ./service-accounts
```