---
title: "SourceIdentity"
description: "Who is behind a bot: the person behind a federated console session or its temporary API key, an OIDC API key's token subject, an instance API key's instance or a Kubernetes API key's cluster."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.ezghcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Trails API

Who is behind a bot: the person behind a federated console session or its temporary API key, an OIDC API key's token subject, an instance API key's instance or a Kubernetes API key's cluster.

## Fields

- `SourceIdentity.principalId` (string, required) — The directory user's ID, or for OidcSubject the OIDC provider's, for ComputeInstance the instance's, for KubernetesPod and KubernetesCluster the cluster's, for BuildTask the build task's, for Sandbox the sandbox's, for DeployStep the deployment step's.
  - format `uuid`
- `SourceIdentity.type` (string, required) — SsoUser, OidcSubject, ComputeInstance, KubernetesPod, KubernetesCluster, BuildTask, Sandbox or DeployStep.
- `SourceIdentity.userName` (string, required) — The directory user's username, or for OidcSubject the token's sub, for ComputeInstance the instance's name, for KubernetesPod namespace/service-account, for KubernetesCluster the cluster's name, for BuildTask pipeline-id/task-name, for Sandbox the sandbox's name, for DeployStep deployment-id/step-id; 1 to 256 characters.


Source: https://docs.ezghcloud.com/trails-api/schemas/SourceIdentity/index.md
