GraphQL¶
The GraphQL connector is a Palantir-provided driver for GraphQL.
To create a new GraphQL source, follow the standard setup flow for Palantir-provided drivers, then use the sections below for GraphQL-specific configuration and networking. For the complete property reference, see the official GraphQL driver documentation ↗.
Configuration¶
The properties below are mandatory or recommended.
| Property | Required? | Description | Default |
|---|---|---|---|
URL ↗ |
Mandatory | Specifies the endpoint URL of the GraphQL service. | https://api.example.com/graphql |
AuthScheme ↗ |
Recommended | Specifies the authentication method to use when connecting to remote services. | Basic |
InitiateOAuth ↗ |
Recommended | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. | REFRESH |
OAuthClientId ↗ |
Recommended | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. | — |
OAuthClientSecret ↗ |
Recommended | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. | — |
Password ↗ |
Recommended | Specifies the password of the authenticating user account. | — |
User ↗ |
Recommended | Specifies the user ID of the authenticating GraphQL user account. | — |
Networking¶
The table below lists the domains that the source needs to be able to access in order to successfully run.
For each domain, add a corresponding egress policy. If the source is hosted on-premises and not directly reachable from Foundry, use an agent proxy egress policy instead; the agent host itself must also be able to reach the listed domains. See using an agent as a proxy for details.
| Domain | Required |
|---|---|
| \ |
Always |
| \ |
If using AuthScheme=OAuth and OAuthVersion=1.0 |
| \ |
If using AuthScheme=OAuth |
| \ |
If using AuthScheme=OAuth |
| \ |
If using AuthScheme=OAuth and OAuthVersion=2.0 |
| cognito-idp.\ |
If AuthScheme=AwsCognitoBasic,AwsCognitoSrp, AWSRegion Mappings |
| cognito-identity.\ |
If AuthScheme=AwsCognitoBasic,AwsCognitoSrp, AWSRegion Mappings |
中文翻译¶
GraphQL¶
GraphQL 连接器是 Palantir 提供的一个用于 GraphQL 的驱动程序。
要创建新的 GraphQL 数据源，请遵循 Palantir 提供驱动程序的标准设置流程，然后使用以下各节进行 GraphQL 特定的配置和网络设置。有关完整的属性参考，请参阅官方 GraphQL 驱动程序文档 ↗。
配置¶
以下属性为必填或推荐项。
| 属性 | 是否必填 | 描述 | 默认值 |
|---|---|---|---|
URL ↗ |
必填 | 指定 GraphQL 服务的端点 URL。 | https://api.example.com/graphql |
AuthScheme ↗ |
推荐 | 指定连接到远程服务时使用的认证方法。 | Basic |
InitiateOAuth ↗ |
推荐 | 指定获取或刷新 OAuth 访问令牌的过程，该令牌用于在已认证授权用户工作时维持其访问权限。 | REFRESH |
OAuthClientId ↗ |
推荐 | 指定分配给自定义 OAuth 应用程序的客户端 ID（也称为消费者密钥）。在认证过程中，需要使用此 ID 向 OAuth 授权服务器标识应用程序。 | — |
OAuthClientSecret ↗ |
推荐 | 指定分配给自定义 OAuth 应用程序的客户端密钥。此机密值用于向 OAuth 授权服务器验证应用程序的身份。 | — |
Password ↗ |
推荐 | 指定认证用户账户的密码。 | — |
User ↗ |
推荐 | 指定认证 GraphQL 用户账户的用户 ID。 | — |
网络设置¶
下表列出了数据源为成功运行而需要能够访问的域名。
对于每个域名，请添加相应的出站策略。如果数据源部署在本地且无法直接从 Foundry 访问，请改用代理出站策略；代理主机本身也必须能够访问所列出的域名。详情请参阅使用代理作为代理服务器。
| 域名 | 必需条件 |
|---|---|
| \ |
始终需要 |
| \ |
如果使用 AuthScheme=OAuth 且 OAuthVersion=1.0 |
| \ |
如果使用 AuthScheme=OAuth |
| \ |
如果使用 AuthScheme=OAuth |
| \ |
如果使用 AuthScheme=OAuth 且 OAuthVersion=2.0 |
| cognito-idp.\ |
如果 AuthScheme=AwsCognitoBasic,AwsCognitoSrp, AWSRegion 映射 |
| cognito-identity.\ |
如果 AuthScheme=AwsCognitoBasic,AwsCognitoSrp, AWSRegion 映射 |