• Documentation
    • Search documentation
    karat

    +

    K

    API Reference ↗
    Data connectivity & integrationAvailable connectorsGraphQL

    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.

    PropertyRequired?DescriptionDefault
    URL ↗MandatorySpecifies the endpoint URL of the GraphQL service.https://api.example.com/graphql
    AuthScheme ↗RecommendedSpecifies the authentication method to use when connecting to remote services.Basic
    InitiateOAuth ↗RecommendedSpecifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.REFRESH
    OAuthClientId ↗RecommendedSpecifies 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 ↗RecommendedSpecifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server.—
    Password ↗RecommendedSpecifies the password of the authenticating user account.—
    User ↗RecommendedSpecifies 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.

    DomainRequired
    <URL>Always
    <OAuthRequestTokenURL>If using AuthScheme=OAuth and OAuthVersion=1.0
    <OAuthAuthorizationURL>If using AuthScheme=OAuth
    <OAuthAccessTokenURL>If using AuthScheme=OAuth
    <OAuthRefreshTokenURL>If using AuthScheme=OAuth and OAuthVersion=2.0
    cognito-idp.<AWSCognitoRegion>.amazonaws.<TLD>If AuthScheme=AwsCognitoBasic,AwsCognitoSrp, AWSRegion Mappings
    cognito-identity.<AWSCognitoRegion>.amazonaws.<TLD>If AuthScheme=AwsCognitoBasic,AwsCognitoSrp, AWSRegion Mappings