--- title: List GitHub cloud authentication persona mappings description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Cloud Authentication --- > For the complete documentation index, see [llms.txt](https://docs.datadoghq.com/llms.txt). # List GitHub cloud authentication persona mappings{% #list-github-cloud-authentication-persona-mappings %} {% tab title="v2" %} **Note**: This endpoint is in Preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). | Datadog site | API endpoint | | ----------------- | -------------------------------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/cloud_auth/github/persona_mapping | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/cloud_auth/github/persona_mapping | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/cloud_auth/github/persona_mapping | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/cloud_auth/github/persona_mapping | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/cloud_auth/github/persona_mapping | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/cloud_auth/github/persona_mapping | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/cloud_auth/github/persona_mapping | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/cloud_auth/github/persona_mapping | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/cloud_auth/github/persona_mapping | ### Overview List all GitHub cloud authentication persona mappings. This endpoint retrieves all configured persona mappings that associate GitHub Actions OpenID Connect (OIDC) principals with Datadog users. Mapped principals can request impersonation tokens. ### Response {% tab title="200" %} OK {% tab title="Model" %} Response containing a list of GitHub cloud authentication persona mappings. | Parent field | Field | Type | Description | | -------------- | ------------------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | [object] | List of GitHub cloud authentication persona mappings. | | data | attributes [*required*] | object | Attributes for GitHub cloud authentication persona mapping response. | | attributes | account_identifier [*required*] | string | Datadog account identifier (email or handle) mapped to the GitHub principal. | | attributes | account_uuid [*required*] | string | Datadog account UUID. | | attributes | claim_matchers [*required*] | object | GitHub Actions OIDC claims to match against. Each field is a regular expression. The `sub` claim is required; all other claims are optional. A token matches only when all provided patterns match simultaneously (AND semantics). | | claim_matchers | actor | string | Regular expression matched against the `actor` claim. | | claim_matchers | actor_id | string | Regular expression matched against the `actor_id` claim. | | claim_matchers | enterprise | string | Regular expression matched against the `enterprise` claim. | | claim_matchers | enterprise_id | string | Regular expression matched against the `enterprise_id` claim. | | claim_matchers | environment | string | Regular expression matched against the `environment` claim. | | claim_matchers | event_name | string | Regular expression matched against the `event_name` claim. | | claim_matchers | job_workflow_ref | string | Regular expression matched against the `job_workflow_ref` claim. | | claim_matchers | ref | string | Regular expression matched against the `ref` claim. | | claim_matchers | ref_type | string | Regular expression matched against the `ref_type` claim. | | claim_matchers | repository | string | Regular expression matched against the `repository` claim. | | claim_matchers | repository_id | string | Regular expression matched against the `repository_id` claim. | | claim_matchers | repository_owner | string | Regular expression matched against the `repository_owner` claim. | | claim_matchers | repository_owner_id | string | Regular expression matched against the `repository_owner_id` claim. | | claim_matchers | repository_visibility | string | Regular expression matched against the `repository_visibility` claim. | | claim_matchers | runner_environment | string | Regular expression matched against the `runner_environment` claim. | | claim_matchers | sub [*required*] | string | Regular expression matched against the entire `sub` (subject) claim, the primary GitHub Actions OIDC identifier (for example, `repo:/:ref:refs/heads/main`). The pattern must begin with `repo:/`, where `` is a literal repository-owner name rather than a regular expression. | | claim_matchers | workflow | string | Regular expression matched against the `workflow` claim. | | claim_matchers | workflow_ref | string | Regular expression matched against the `workflow_ref` claim. | | data | id [*required*] | string | Unique identifier for the persona mapping. | | data | type [*required*] | enum | Type identifier for GitHub cloud authentication persona mapping. Allowed enum values: `github_oidc_auth_config` | {% /tab %} {% tab title="Example" %} ```json { "data": [ { "attributes": { "account_identifier": "test@example.com", "account_uuid": "12bbdc5c-5966-47e0-8733-285f9e44bcf4", "claim_matchers": { "actor": "octocat", "actor_id": "1234567", "enterprise": "test_enterprise", "enterprise_id": "42", "environment": "production", "event_name": "push", "job_workflow_ref": "test_owner/test_repo/.github/workflows/jobs.yml@refs/heads/main", "ref": "refs/heads/main", "ref_type": "branch", "repository": "test_owner/test_repo", "repository_id": "123456789", "repository_owner": "test_owner", "repository_owner_id": "987654321", "repository_visibility": "public", "runner_environment": "github-hosted", "sub": "repo:test_owner/test_repo:(ref:refs/heads/main|pull_request)", "workflow": "CI", "workflow_ref": "test_owner/test_repo/.github/workflows/ci.yml@refs/heads/main" } }, "id": "c5c758c6-18c2-4484-ae3f-46b84128404a", "type": "github_oidc_auth_config" } ] } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" \# Curl command curl -X GET "https://api.datadoghq.com/api/v2/cloud_auth/github/persona_mapping" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ##### ```python """ List GitHub cloud authentication persona mappings returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.cloud_authentication_api import CloudAuthenticationApi configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] configuration.unstable_operations["list_git_hub_cloud_auth_persona_mappings"] = True with ApiClient(configuration) as api_client: api_instance = CloudAuthenticationApi(api_client) response = api_instance.list_git_hub_cloud_auth_persona_mappings() print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ##### ```ruby # List GitHub cloud authentication persona mappings returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] config.unstable_operations["v2.list_git_hub_cloud_auth_persona_mappings".to_sym] = true end api_instance = DatadogAPIClient::V2::CloudAuthenticationAPI.new p api_instance.list_git_hub_cloud_auth_persona_mappings() ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ##### ```go // List GitHub cloud authentication persona mappings returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() configuration.SetUnstableOperationEnabled("v2.ListGitHubCloudAuthPersonaMappings", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewCloudAuthenticationApi(apiClient) resp, r, err := api.ListGitHubCloudAuthPersonaMappings(ctx) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `CloudAuthenticationApi.ListGitHubCloudAuthPersonaMappings`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `CloudAuthenticationApi.ListGitHubCloudAuthPersonaMappings`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ##### ```java // List GitHub cloud authentication persona mappings returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.CloudAuthenticationApi; import com.datadog.api.client.v2.model.GitHubCloudAuthPersonaMappingsResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); defaultClient.setUnstableOperationEnabled("v2.listGitHubCloudAuthPersonaMappings", true); CloudAuthenticationApi apiInstance = new CloudAuthenticationApi(defaultClient); try { GitHubCloudAuthPersonaMappingsResponse result = apiInstance.listGitHubCloudAuthPersonaMappings(); System.out.println(result); } catch (ApiException e) { System.err.println( "Exception when calling CloudAuthenticationApi#listGitHubCloudAuthPersonaMappings"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ##### ```rust // List GitHub cloud authentication persona mappings returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_cloud_authentication::CloudAuthenticationAPI; #[tokio::main] async fn main() { let mut configuration = datadog::Configuration::new(); configuration .set_unstable_operation_enabled("v2.list_git_hub_cloud_auth_persona_mappings", true); let api = CloudAuthenticationAPI::with_config(configuration); let resp = api.list_git_hub_cloud_auth_persona_mappings().await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run {% /tab %}