Add a comment about audience

buildkite · Nov 10, 2022 · 3c55028 · 3c55028
1 parent 8275e2c
commit 3c55028
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/api/oidc.go b/api/oidc.go
@@ -23,6 +23,9 @@ func (c *Client) OidcToken(jobId string, audience ...string) (*OidcToken, *Respo
 	case 1:
 		m = &oidcTokenRequest{Audience: audience[0]}
 	default:
+		// While the spec supports multiple audiences in an Id JWT, our API does
+		// not support issuing them.
+		// See: https://openid.net/specs/openid-connect-core-1_0.html#IDToken.
 		return nil, nil, ErrAudienceTooLong
 	}