Browse the data providers configured in the environment, manage which ones the organization can use, and connect or disconnect the authenticated user’s own accounts.
List the data providers configured in the token’s environment.
GraphQL
| query DataProviders($after: String, $before: String, $limit: Int, $order: PaginationOrder) { | |
| dataProviders(after: $after, before: $before, limit: $limit, order: $order) { | |
| data { | |
| authMethods | |
| config { | |
| name | |
| value | |
| } | |
| configFields { | |
| default | |
| description | |
| example | |
| key | |
| label | |
| order | |
| pattern | |
| patternFlags | |
| required | |
| scope | |
| secret | |
| } | |
| createdAt | |
| credentialsType | |
| description | |
| enabled | |
| iconDarkUrl | |
| iconSlug | |
| iconUrl | |
| id | |
| integrationType | |
| name | |
| scopes | |
| slug | |
| state | |
| updatedAt | |
| } | |
| listMetadata { | |
| after | |
| before | |
| } | |
| } | |
| } |
| { | |
| "data": { | |
| "dataProviders": { | |
| "data": [ | |
| { | |
| "authMethods": [ | |
| "authMethods_example" | |
| ], | |
| "config": [ | |
| { | |
| "name": "name_example", | |
| "value": "value_example" | |
| } | |
| ], | |
| "configFields": [ | |
| { | |
| "default": "default_example", | |
| "description": "description_example", | |
| "example": "example_example", | |
| "key": "key_example", | |
| "label": "label_example", | |
| "order": 10, | |
| "pattern": "pattern_example", | |
| "patternFlags": "patternFlags_example", | |
| "required": true, | |
| "scope": "scope_example", | |
| "secret": true | |
| } | |
| ], | |
| "createdAt": "2024-01-01T00:00:00.000Z", | |
| "credentialsType": "credentialsType_example", | |
| "description": "description_example", | |
| "enabled": true, | |
| "iconDarkUrl": "iconDarkUrl_example", | |
| "iconSlug": "iconSlug_example", | |
| "iconUrl": "iconUrl_example", | |
| "id": "id_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "integrationType": "integrationType_example", | |
| "name": "name_example", | |
| "scopes": [ | |
| "scopes_example" | |
| ], | |
| "slug": "slug_example", | |
| "state": "state_example", | |
| "updatedAt": "2024-01-01T00:00:00.000Z" | |
| } | |
| ], | |
| "listMetadata": { | |
| "after": "after_example", | |
| "before": "before_example" | |
| } | |
| } | |
| } | |
| } |
dataProviders
Parameters
after: String
before: String
limit: Int
Returns DataProviderList!
Return a data provider by ID within the token’s environment.
GraphQL
| query DataProvider($id: ID!) { | |
| dataProvider(id: $id) { | |
| authMethods | |
| config { | |
| name | |
| value | |
| } | |
| configFields { | |
| default | |
| description | |
| example | |
| key | |
| label | |
| order | |
| pattern | |
| patternFlags | |
| required | |
| scope | |
| secret | |
| } | |
| createdAt | |
| credentialsType | |
| description | |
| enabled | |
| iconDarkUrl | |
| iconSlug | |
| iconUrl | |
| id | |
| integrationType | |
| name | |
| scopes | |
| slug | |
| state | |
| updatedAt | |
| } | |
| } |
| { | |
| "data": { | |
| "dataProvider": { | |
| "authMethods": [ | |
| "authMethods_example" | |
| ], | |
| "config": [ | |
| { | |
| "name": "name_example", | |
| "value": "value_example" | |
| } | |
| ], | |
| "configFields": [ | |
| { | |
| "default": "default_example", | |
| "description": "description_example", | |
| "example": "example_example", | |
| "key": "key_example", | |
| "label": "label_example", | |
| "order": 10, | |
| "pattern": "pattern_example", | |
| "patternFlags": "patternFlags_example", | |
| "required": true, | |
| "scope": "scope_example", | |
| "secret": true | |
| } | |
| ], | |
| "createdAt": "2024-01-01T00:00:00.000Z", | |
| "credentialsType": "credentialsType_example", | |
| "description": "description_example", | |
| "enabled": true, | |
| "iconDarkUrl": "iconDarkUrl_example", | |
| "iconSlug": "iconSlug_example", | |
| "iconUrl": "iconUrl_example", | |
| "id": "id_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "integrationType": "integrationType_example", | |
| "name": "name_example", | |
| "scopes": [ | |
| "scopes_example" | |
| ], | |
| "slug": "slug_example", | |
| "state": "state_example", | |
| "updatedAt": "2024-01-01T00:00:00.000Z" | |
| } | |
| } | |
| } |
dataProvider
Parameters
id: ID!
Returns DataProvider!
createdAt: DateTime!
description: String
id: ID!
updatedAt: DateTime!
List the authenticated user’s data provider connections, including their status.
GraphQL
| query DataProviderConnections($after: String, $before: String, $limit: Int, $order: PaginationOrder) { | |
| dataProviderConnections(after: $after, before: $before, limit: $limit, order: $order) { | |
| data { | |
| accountDisplayName | |
| accountIdentifier | |
| apiKeyLast4 | |
| authMethod | |
| availability | |
| clientId | |
| clientSecretLast4 | |
| config { | |
| name | |
| value | |
| } | |
| connectionRole | |
| createdAt | |
| dataProviderId | |
| dataProviderSlug | |
| id | |
| organizationId | |
| scopes | |
| state | |
| updatedAt | |
| userId | |
| } | |
| listMetadata { | |
| after | |
| before | |
| } | |
| } | |
| } |
| { | |
| "data": { | |
| "dataProviderConnections": { | |
| "data": [ | |
| { | |
| "accountDisplayName": "accountDisplayName_example", | |
| "accountIdentifier": "accountIdentifier_example", | |
| "apiKeyLast4": "apiKeyLast4_example", | |
| "authMethod": "authMethod_example", | |
| "availability": "availability_example", | |
| "clientId": "clientId_example", | |
| "clientSecretLast4": "clientSecretLast4_example", | |
| "config": [ | |
| { | |
| "name": "name_example", | |
| "value": "value_example" | |
| } | |
| ], | |
| "connectionRole": "Compatibility", | |
| "createdAt": "2024-01-01T00:00:00.000Z", | |
| "dataProviderId": "dataProviderId_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "dataProviderSlug": "dataProviderSlug_example", | |
| "id": "id_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "organizationId": "organizationId_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "scopes": [ | |
| "scopes_example" | |
| ], | |
| "state": "state_example", | |
| "updatedAt": "2024-01-01T00:00:00.000Z", | |
| "userId": "userId_01EHWNCE74X7JSDV0X3SZ3KJNY" | |
| } | |
| ], | |
| "listMetadata": { | |
| "after": "after_example", | |
| "before": "before_example" | |
| } | |
| } | |
| } | |
| } |
dataProviderConnections
Parameters
after: String
before: String
limit: Int
Returns DataProviderConnectionList!
Return one of the authenticated user’s data provider connections by ID.
GraphQL
| query DataProviderConnection($id: ID!) { | |
| dataProviderConnection(id: $id) { | |
| accountDisplayName | |
| accountIdentifier | |
| apiKeyLast4 | |
| authMethod | |
| availability | |
| clientId | |
| clientSecretLast4 | |
| config { | |
| name | |
| value | |
| } | |
| connectionRole | |
| createdAt | |
| dataProviderId | |
| dataProviderSlug | |
| id | |
| organizationId | |
| scopes | |
| state | |
| updatedAt | |
| userId | |
| } | |
| } |
| { | |
| "data": { | |
| "dataProviderConnection": { | |
| "accountDisplayName": "accountDisplayName_example", | |
| "accountIdentifier": "accountIdentifier_example", | |
| "apiKeyLast4": "apiKeyLast4_example", | |
| "authMethod": "authMethod_example", | |
| "availability": "availability_example", | |
| "clientId": "clientId_example", | |
| "clientSecretLast4": "clientSecretLast4_example", | |
| "config": [ | |
| { | |
| "name": "name_example", | |
| "value": "value_example" | |
| } | |
| ], | |
| "connectionRole": "Compatibility", | |
| "createdAt": "2024-01-01T00:00:00.000Z", | |
| "dataProviderId": "dataProviderId_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "dataProviderSlug": "dataProviderSlug_example", | |
| "id": "id_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "organizationId": "organizationId_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "scopes": [ | |
| "scopes_example" | |
| ], | |
| "state": "state_example", | |
| "updatedAt": "2024-01-01T00:00:00.000Z", | |
| "userId": "userId_01EHWNCE74X7JSDV0X3SZ3KJNY" | |
| } | |
| } | |
| } |
dataProviderConnection
Parameters
id: ID!
Returns DataProviderConnection!
createdAt: DateTime!
id: ID!
organizationId: ID
updatedAt: DateTime!
userId: ID
Connect the authenticated user to a data provider with an API key the user supplies. Replaces the API key when the user already has an API-key connection to the data provider.
GraphQL
| mutation CreateDataProviderConnection($input: CreateDataProviderConnectionInput!) { | |
| createDataProviderConnection(input: $input) { | |
| accountDisplayName | |
| accountIdentifier | |
| apiKeyLast4 | |
| authMethod | |
| availability | |
| clientId | |
| clientSecretLast4 | |
| config { | |
| name | |
| value | |
| } | |
| connectionRole | |
| createdAt | |
| dataProviderId | |
| dataProviderSlug | |
| id | |
| organizationId | |
| scopes | |
| state | |
| updatedAt | |
| userId | |
| } | |
| } |
| { | |
| "data": { | |
| "createDataProviderConnection": { | |
| "accountDisplayName": "accountDisplayName_example", | |
| "accountIdentifier": "accountIdentifier_example", | |
| "apiKeyLast4": "apiKeyLast4_example", | |
| "authMethod": "authMethod_example", | |
| "availability": "availability_example", | |
| "clientId": "clientId_example", | |
| "clientSecretLast4": "clientSecretLast4_example", | |
| "config": [ | |
| { | |
| "name": "name_example", | |
| "value": "value_example" | |
| } | |
| ], | |
| "connectionRole": "Compatibility", | |
| "createdAt": "2024-01-01T00:00:00.000Z", | |
| "dataProviderId": "dataProviderId_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "dataProviderSlug": "dataProviderSlug_example", | |
| "id": "id_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "organizationId": "organizationId_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "scopes": [ | |
| "scopes_example" | |
| ], | |
| "state": "state_example", | |
| "updatedAt": "2024-01-01T00:00:00.000Z", | |
| "userId": "userId_01EHWNCE74X7JSDV0X3SZ3KJNY" | |
| } | |
| } | |
| } |
createDataProviderConnection
Parameters CreateDataProviderConnectionInput!
Returns DataProviderConnection!
createdAt: DateTime!
id: ID!
organizationId: ID
updatedAt: DateTime!
userId: ID
Disconnect one of the authenticated user’s data provider connections, revoking the stored credentials.
GraphQL
| mutation DeleteDataProviderConnection($id: ID!) { | |
| deleteDataProviderConnection(id: $id) | |
| } |
| { | |
| "data": { | |
| "deleteDataProviderConnection": "deleteDataProviderConnection_01EHWNCE74X7JSDV0X3SZ3KJNY" | |
| } | |
| } |
deleteDataProviderConnection
Parameters
id: ID!
Returns
deleteDataProviderConnection: ID!
Enable or disable a data provider for the token’s organization. Disabling it hides the data provider from the organization’s users and stops new connections; existing connections stay readable so they can be disconnected.
GraphQL
| mutation SetDataProviderEnabled($input: SetDataProviderEnabledInput!) { | |
| setDataProviderEnabled(input: $input) { | |
| authMethods | |
| config { | |
| name | |
| value | |
| } | |
| configFields { | |
| default | |
| description | |
| example | |
| key | |
| label | |
| order | |
| pattern | |
| patternFlags | |
| required | |
| scope | |
| secret | |
| } | |
| createdAt | |
| credentialsType | |
| description | |
| enabled | |
| iconDarkUrl | |
| iconSlug | |
| iconUrl | |
| id | |
| integrationType | |
| name | |
| scopes | |
| slug | |
| state | |
| updatedAt | |
| } | |
| } |
| { | |
| "data": { | |
| "setDataProviderEnabled": { | |
| "authMethods": [ | |
| "authMethods_example" | |
| ], | |
| "config": [ | |
| { | |
| "name": "name_example", | |
| "value": "value_example" | |
| } | |
| ], | |
| "configFields": [ | |
| { | |
| "default": "default_example", | |
| "description": "description_example", | |
| "example": "example_example", | |
| "key": "key_example", | |
| "label": "label_example", | |
| "order": 10, | |
| "pattern": "pattern_example", | |
| "patternFlags": "patternFlags_example", | |
| "required": true, | |
| "scope": "scope_example", | |
| "secret": true | |
| } | |
| ], | |
| "createdAt": "2024-01-01T00:00:00.000Z", | |
| "credentialsType": "credentialsType_example", | |
| "description": "description_example", | |
| "enabled": true, | |
| "iconDarkUrl": "iconDarkUrl_example", | |
| "iconSlug": "iconSlug_example", | |
| "iconUrl": "iconUrl_example", | |
| "id": "id_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "integrationType": "integrationType_example", | |
| "name": "name_example", | |
| "scopes": [ | |
| "scopes_example" | |
| ], | |
| "slug": "slug_example", | |
| "state": "state_example", | |
| "updatedAt": "2024-01-01T00:00:00.000Z" | |
| } | |
| } | |
| } |
setDataProviderEnabled
Parameters SetDataProviderEnabledInput!
dataProviderId: ID!
Returns DataProvider!
createdAt: DateTime!
description: String
id: ID!
updatedAt: DateTime!
List the data providers the token’s organization connects on behalf of all its members, with the organization’s shared connection when it has one.
GraphQL
| query OrganizationDataProviders($after: String, $before: String, $limit: Int, $order: PaginationOrder) { | |
| organizationDataProviders(after: $after, before: $before, limit: $limit, order: $order) { | |
| data { | |
| authMethods | |
| availableScopes | |
| capabilities { | |
| canConfigure | |
| canConnect | |
| canDisconnect | |
| canReauthorize | |
| canUpdateCredentials | |
| } | |
| config { | |
| name | |
| value | |
| } | |
| configFields { | |
| default | |
| description | |
| example | |
| key | |
| label | |
| order | |
| pattern | |
| patternFlags | |
| required | |
| scope | |
| secret | |
| } | |
| configured | |
| connectedAccounts { | |
| accountDisplayName | |
| accountIdentifier | |
| apiKeyLast4 | |
| authMethod | |
| availability | |
| clientId | |
| clientSecretLast4 | |
| connectionRole | |
| createdAt | |
| dataProviderId | |
| dataProviderSlug | |
| id | |
| organizationId | |
| scopes | |
| state | |
| updatedAt | |
| userId | |
| } | |
| connection { | |
| accountDisplayName | |
| accountIdentifier | |
| apiKeyLast4 | |
| authMethod | |
| availability | |
| clientId | |
| clientSecretLast4 | |
| connectionRole | |
| createdAt | |
| dataProviderId | |
| dataProviderSlug | |
| id | |
| organizationId | |
| scopes | |
| state | |
| updatedAt | |
| userId | |
| } | |
| createdAt | |
| credentials { | |
| clientId | |
| credentialsType | |
| hasCredentials | |
| redactedClientSecret | |
| redirectUri | |
| } | |
| credentialsType | |
| defaultScopes | |
| description | |
| disabledSource | |
| enabled | |
| hasCredentials | |
| iconDarkUrl | |
| iconSlug | |
| iconUrl | |
| id | |
| integrationType | |
| name | |
| scopes | |
| slug | |
| state | |
| updatedAt | |
| } | |
| listMetadata { | |
| after | |
| before | |
| } | |
| } | |
| } |
| { | |
| "data": { | |
| "organizationDataProviders": { | |
| "data": [ | |
| { | |
| "authMethods": [ | |
| "authMethods_example" | |
| ], | |
| "availableScopes": [ | |
| "availableScopes_example" | |
| ], | |
| "capabilities": { | |
| "canConfigure": true, | |
| "canConnect": true, | |
| "canDisconnect": true, | |
| "canReauthorize": true, | |
| "canUpdateCredentials": true | |
| }, | |
| "config": [ | |
| { | |
| "name": "name_example", | |
| "value": "value_example" | |
| } | |
| ], | |
| "configFields": [ | |
| { | |
| "default": "default_example", | |
| "description": "description_example", | |
| "example": "example_example", | |
| "key": "key_example", | |
| "label": "label_example", | |
| "order": 10, | |
| "pattern": "pattern_example", | |
| "patternFlags": "patternFlags_example", | |
| "required": true, | |
| "scope": "scope_example", | |
| "secret": true | |
| } | |
| ], | |
| "configured": true, | |
| "connectedAccounts": [ | |
| { | |
| "accountDisplayName": "accountDisplayName_example", | |
| "accountIdentifier": "accountIdentifier_example", | |
| "apiKeyLast4": "apiKeyLast4_example", | |
| "authMethod": "authMethod_example", | |
| "availability": "availability_example", | |
| "clientId": "clientId_example", | |
| "clientSecretLast4": "clientSecretLast4_example", | |
| "connectionRole": "Compatibility", | |
| "createdAt": "2024-01-01T00:00:00.000Z", | |
| "dataProviderId": "dataProviderId_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "dataProviderSlug": "dataProviderSlug_example", | |
| "id": "id_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "organizationId": "organizationId_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "scopes": [ | |
| "scopes_example" | |
| ], | |
| "state": "state_example", | |
| "updatedAt": "2024-01-01T00:00:00.000Z", | |
| "userId": "userId_01EHWNCE74X7JSDV0X3SZ3KJNY" | |
| } | |
| ], | |
| "connection": { | |
| "accountDisplayName": "accountDisplayName_example", | |
| "accountIdentifier": "accountIdentifier_example", | |
| "apiKeyLast4": "apiKeyLast4_example", | |
| "authMethod": "authMethod_example", | |
| "availability": "availability_example", | |
| "clientId": "clientId_example", | |
| "clientSecretLast4": "clientSecretLast4_example", | |
| "connectionRole": "Compatibility", | |
| "createdAt": "2024-01-01T00:00:00.000Z", | |
| "dataProviderId": "dataProviderId_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "dataProviderSlug": "dataProviderSlug_example", | |
| "id": "id_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "organizationId": "organizationId_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "scopes": [ | |
| "scopes_example" | |
| ], | |
| "state": "state_example", | |
| "updatedAt": "2024-01-01T00:00:00.000Z", | |
| "userId": "userId_01EHWNCE74X7JSDV0X3SZ3KJNY" | |
| }, | |
| "createdAt": "2024-01-01T00:00:00.000Z", | |
| "credentials": { | |
| "clientId": "clientId_example", | |
| "credentialsType": "credentialsType_example", | |
| "hasCredentials": true, | |
| "redactedClientSecret": "redactedClientSecret_example", | |
| "redirectUri": "redirectUri_example" | |
| }, | |
| "credentialsType": "credentialsType_example", | |
| "defaultScopes": [ | |
| "defaultScopes_example" | |
| ], | |
| "description": "description_example", | |
| "disabledSource": "disabledSource_example", | |
| "enabled": true, | |
| "hasCredentials": true, | |
| "iconDarkUrl": "iconDarkUrl_example", | |
| "iconSlug": "iconSlug_example", | |
| "iconUrl": "iconUrl_example", | |
| "id": "id_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "integrationType": "integrationType_example", | |
| "name": "name_example", | |
| "scopes": [ | |
| "scopes_example" | |
| ], | |
| "slug": "slug_example", | |
| "state": "state_example", | |
| "updatedAt": "2024-01-01T00:00:00.000Z" | |
| } | |
| ], | |
| "listMetadata": { | |
| "after": "after_example", | |
| "before": "before_example" | |
| } | |
| } | |
| } | |
| } |
organizationDataProviders
Parameters
after: String
before: String
limit: Int
Returns OrganizationDataProviderList!
List the data providers the token’s organization can configure for its members, with the organization’s current configuration of each.
GraphQL
| query ConfigurableDataProviders($after: String, $before: String, $limit: Int, $order: PaginationOrder) { | |
| configurableDataProviders(after: $after, before: $before, limit: $limit, order: $order) { | |
| data { | |
| authMethods | |
| availableScopes | |
| config { | |
| name | |
| value | |
| } | |
| configFields { | |
| default | |
| description | |
| example | |
| key | |
| label | |
| order | |
| pattern | |
| patternFlags | |
| required | |
| scope | |
| secret | |
| } | |
| createdAt | |
| credentials { | |
| clientId | |
| credentialsType | |
| hasCredentials | |
| redactedClientSecret | |
| redirectUri | |
| } | |
| credentialsType | |
| defaultScopes | |
| description | |
| enabled | |
| iconDarkUrl | |
| iconSlug | |
| iconUrl | |
| id | |
| integrationType | |
| name | |
| scopes | |
| slug | |
| state | |
| updatedAt | |
| } | |
| listMetadata { | |
| after | |
| before | |
| } | |
| } | |
| } |
| { | |
| "data": { | |
| "configurableDataProviders": { | |
| "data": [ | |
| { | |
| "authMethods": [ | |
| "authMethods_example" | |
| ], | |
| "availableScopes": [ | |
| "availableScopes_example" | |
| ], | |
| "config": [ | |
| { | |
| "name": "name_example", | |
| "value": "value_example" | |
| } | |
| ], | |
| "configFields": [ | |
| { | |
| "default": "default_example", | |
| "description": "description_example", | |
| "example": "example_example", | |
| "key": "key_example", | |
| "label": "label_example", | |
| "order": 10, | |
| "pattern": "pattern_example", | |
| "patternFlags": "patternFlags_example", | |
| "required": true, | |
| "scope": "scope_example", | |
| "secret": true | |
| } | |
| ], | |
| "createdAt": "2024-01-01T00:00:00.000Z", | |
| "credentials": { | |
| "clientId": "clientId_example", | |
| "credentialsType": "credentialsType_example", | |
| "hasCredentials": true, | |
| "redactedClientSecret": "redactedClientSecret_example", | |
| "redirectUri": "redirectUri_example" | |
| }, | |
| "credentialsType": "credentialsType_example", | |
| "defaultScopes": [ | |
| "defaultScopes_example" | |
| ], | |
| "description": "description_example", | |
| "enabled": true, | |
| "iconDarkUrl": "iconDarkUrl_example", | |
| "iconSlug": "iconSlug_example", | |
| "iconUrl": "iconUrl_example", | |
| "id": "id_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "integrationType": "integrationType_example", | |
| "name": "name_example", | |
| "scopes": [ | |
| "scopes_example" | |
| ], | |
| "slug": "slug_example", | |
| "state": "state_example", | |
| "updatedAt": "2024-01-01T00:00:00.000Z" | |
| } | |
| ], | |
| "listMetadata": { | |
| "after": "after_example", | |
| "before": "before_example" | |
| } | |
| } | |
| } | |
| } |
configurableDataProviders
Parameters
after: String
before: String
limit: Int
Returns ConfigurableDataProviderList!
List the data providers the token’s organization has connected for all its members, with the shared connections the caller may use. Available to any active member of the organization.
GraphQL
| query SharedDataProviders($after: String, $before: String, $limit: Int, $order: PaginationOrder, $supportsMultipleConnections: Boolean) { | |
| sharedDataProviders(after: $after, before: $before, limit: $limit, order: $order, supportsMultipleConnections: $supportsMultipleConnections) { | |
| data { | |
| connectedAccounts { | |
| authMethod | |
| availability | |
| connectionRole | |
| createdAt | |
| dataProviderId | |
| dataProviderSlug | |
| id | |
| state | |
| updatedAt | |
| } | |
| createdAt | |
| description | |
| iconDarkUrl | |
| iconSlug | |
| iconUrl | |
| id | |
| integrationType | |
| name | |
| slug | |
| updatedAt | |
| } | |
| listMetadata { | |
| after | |
| before | |
| } | |
| } | |
| } |
| { | |
| "data": { | |
| "sharedDataProviders": { | |
| "data": [ | |
| { | |
| "connectedAccounts": [ | |
| { | |
| "authMethod": "authMethod_example", | |
| "availability": "availability_example", | |
| "connectionRole": "Compatibility", | |
| "createdAt": "2024-01-01T00:00:00.000Z", | |
| "dataProviderId": "dataProviderId_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "dataProviderSlug": "dataProviderSlug_example", | |
| "id": "id_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "state": "state_example", | |
| "updatedAt": "2024-01-01T00:00:00.000Z" | |
| } | |
| ], | |
| "createdAt": "2024-01-01T00:00:00.000Z", | |
| "description": "description_example", | |
| "iconDarkUrl": "iconDarkUrl_example", | |
| "iconSlug": "iconSlug_example", | |
| "iconUrl": "iconUrl_example", | |
| "id": "id_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "integrationType": "integrationType_example", | |
| "name": "name_example", | |
| "slug": "slug_example", | |
| "updatedAt": "2024-01-01T00:00:00.000Z" | |
| } | |
| ], | |
| "listMetadata": { | |
| "after": "after_example", | |
| "before": "before_example" | |
| } | |
| } | |
| } | |
| } |
sharedDataProviders
Parameters
after: String
before: String
limit: Int
Returns SharedDataProviderList!
Start an OAuth authorization connecting the authenticated user to a data provider. Returns the URL to open in a popup and the state to poll with dataProviderAuthorizationStatus. Re-authorizing a provider the user is already connected to replaces that connection’s credentials once the flow completes, so this is also the reconnect path.
GraphQL
| mutation CreateDataProviderAuthorization($input: CreateDataProviderAuthorizationInput!) { | |
| createDataProviderAuthorization(input: $input) { | |
| __typename | |
| ... on DataProviderAuthorization { | |
| handoffToken | |
| redirectToken | |
| state | |
| url | |
| } | |
| ... on DataProviderAuthorizationUnavailable { | |
| message | |
| } | |
| ... on DataProviderConfigInvalid { | |
| message | |
| } | |
| } | |
| } |
| { | |
| "data": { | |
| "createDataProviderAuthorization": { | |
| "__typename": "DataProviderAuthorization", | |
| "handoffToken": "handoffToken_example", | |
| "redirectToken": "redirectToken_example", | |
| "state": "state_example", | |
| "url": "url_example" | |
| } | |
| } | |
| } |
createDataProviderAuthorization
Parameters CreateDataProviderAuthorizationInput!
Returns CreateDataProviderAuthorizationResult!
Start an OAuth authorization connecting the token’s organization to an organization-owned data provider, producing one connection shared by every member. A handoff is always required: the member completing the flow must confirm it explicitly because the resulting connection is not their own.
GraphQL
| mutation CreateOrganizationDataProviderAuthorization($input: CreateOrganizationDataProviderAuthorizationInput!) { | |
| createOrganizationDataProviderAuthorization(input: $input) { | |
| __typename | |
| ... on DataProviderAuthorization { | |
| handoffToken | |
| redirectToken | |
| state | |
| url | |
| } | |
| ... on DataProviderAuthorizationUnavailable { | |
| message | |
| } | |
| ... on DataProviderConfigInvalid { | |
| message | |
| } | |
| } | |
| } |
| { | |
| "data": { | |
| "createOrganizationDataProviderAuthorization": { | |
| "__typename": "DataProviderAuthorization", | |
| "handoffToken": "handoffToken_example", | |
| "redirectToken": "redirectToken_example", | |
| "state": "state_example", | |
| "url": "url_example" | |
| } | |
| } | |
| } |
createOrganizationDataProviderAuthorization
Parameters CreateOrganizationDataProviderAuthorizationInput!
Returns CreateDataProviderAuthorizationResult!
Report whether an authorization attempt is still outstanding. Poll this with the state returned when the authorization was created while the popup is open; it flips to connecting: false once the provider callback has been handled or the attempt expired.
GraphQL
| query DataProviderAuthorizationStatus($dataProviderId: ID!, $state: String!) { | |
| dataProviderAuthorizationStatus(dataProviderId: $dataProviderId, state: $state) { | |
| connecting | |
| state | |
| } | |
| } |
| { | |
| "data": { | |
| "dataProviderAuthorizationStatus": { | |
| "connecting": true, | |
| "state": "state_example" | |
| } | |
| } | |
| } |
dataProviderAuthorizationStatus
Parameters
Returns DataProviderAuthorizationStatus!
Connect the authenticated user to a data provider with OAuth client credentials the user supplies. Replaces the credentials when the user already has a client-credentials connection to the data provider, so this is both the connect and the reconnect path. The credentials are stored encrypted and never returned.
GraphQL
| mutation ConnectDataProviderWithClientCredentials($input: ConnectDataProviderWithClientCredentialsInput!) { | |
| connectDataProviderWithClientCredentials(input: $input) { | |
| __typename | |
| ... on DataProviderAuthMethodUnsupported { | |
| authMethod | |
| supportedAuthMethods | |
| } | |
| ... on DataProviderConfigInvalid { | |
| message | |
| } | |
| ... on DataProviderConnected { | |
| connection { | |
| accountDisplayName | |
| accountIdentifier | |
| apiKeyLast4 | |
| authMethod | |
| availability | |
| clientId | |
| clientSecretLast4 | |
| connectionRole | |
| createdAt | |
| dataProviderId | |
| dataProviderSlug | |
| id | |
| organizationId | |
| scopes | |
| state | |
| updatedAt | |
| userId | |
| } | |
| } | |
| ... on DataProviderConnectionAuthMethodConflict { | |
| existingAuthMethod | |
| } | |
| } | |
| } |
| { | |
| "data": { | |
| "connectDataProviderWithClientCredentials": { | |
| "__typename": "DataProviderAuthMethodUnsupported", | |
| "authMethod": "authMethod_example", | |
| "supportedAuthMethods": [ | |
| "supportedAuthMethods_example" | |
| ] | |
| } | |
| } | |
| } |
connectDataProviderWithClientCredentials
Parameters ConnectDataProviderWithClientCredentialsInput!
Returns ConnectDataProviderResult!
Write a data provider’s configuration for the token’s organization: whether the organization’s members can connect it, the scopes it requests, the organization’s own OAuth client credentials, and any non-secret configuration values the provider declares. Fields left out are unchanged. Supersedes setDataProviderEnabled for anything beyond toggling enabled.
GraphQL
| mutation SetDataProviderConfiguration($input: SetDataProviderConfigurationInput!) { | |
| setDataProviderConfiguration(input: $input) { | |
| __typename | |
| ... on DataProviderConfigInvalid { | |
| message | |
| } | |
| ... on DataProviderConfiguration { | |
| availableScopes | |
| config { | |
| name | |
| value | |
| } | |
| dataProviderId | |
| dataProviderSlug | |
| enabled | |
| hasCredentials | |
| organizationId | |
| scopes | |
| updatedAt | |
| } | |
| } | |
| } |
| { | |
| "data": { | |
| "setDataProviderConfiguration": { | |
| "__typename": "DataProviderConfigInvalid", | |
| "message": "message_example" | |
| } | |
| } | |
| } |
setDataProviderConfiguration
Parameters SetDataProviderConfigurationInput!
Returns SetDataProviderConfigurationResult!
Connect the token’s organization to an organization-owned data provider with an API key, producing one connection shared by every member. Replaces the API key when the organization already has an API-key connection to the data provider.
GraphQL
| mutation CreateOrganizationDataProviderConnection($input: CreateOrganizationDataProviderConnectionInput!) { | |
| createOrganizationDataProviderConnection(input: $input) { | |
| accountDisplayName | |
| accountIdentifier | |
| apiKeyLast4 | |
| authMethod | |
| availability | |
| clientId | |
| clientSecretLast4 | |
| config { | |
| name | |
| value | |
| } | |
| connectionRole | |
| createdAt | |
| dataProviderId | |
| dataProviderSlug | |
| id | |
| organizationId | |
| scopes | |
| state | |
| updatedAt | |
| userId | |
| } | |
| } |
| { | |
| "data": { | |
| "createOrganizationDataProviderConnection": { | |
| "accountDisplayName": "accountDisplayName_example", | |
| "accountIdentifier": "accountIdentifier_example", | |
| "apiKeyLast4": "apiKeyLast4_example", | |
| "authMethod": "authMethod_example", | |
| "availability": "availability_example", | |
| "clientId": "clientId_example", | |
| "clientSecretLast4": "clientSecretLast4_example", | |
| "config": [ | |
| { | |
| "name": "name_example", | |
| "value": "value_example" | |
| } | |
| ], | |
| "connectionRole": "Compatibility", | |
| "createdAt": "2024-01-01T00:00:00.000Z", | |
| "dataProviderId": "dataProviderId_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "dataProviderSlug": "dataProviderSlug_example", | |
| "id": "id_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "organizationId": "organizationId_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "scopes": [ | |
| "scopes_example" | |
| ], | |
| "state": "state_example", | |
| "updatedAt": "2024-01-01T00:00:00.000Z", | |
| "userId": "userId_01EHWNCE74X7JSDV0X3SZ3KJNY" | |
| } | |
| } | |
| } |
createOrganizationDataProviderConnection
Parameters CreateOrganizationDataProviderConnectionInput!
Returns DataProviderConnection!
createdAt: DateTime!
id: ID!
organizationId: ID
updatedAt: DateTime!
userId: ID
Connect the token’s organization to an organization-owned data provider with OAuth client credentials, producing one connection shared by every member. Replaces the credentials when the organization already has a client-credentials connection to the data provider, so this is both the connect and the reconnect path. The credentials are stored encrypted and never returned.
GraphQL
| mutation ConnectOrganizationDataProviderWithClientCredentials($input: ConnectOrganizationDataProviderWithClientCredentialsInput!) { | |
| connectOrganizationDataProviderWithClientCredentials(input: $input) { | |
| __typename | |
| ... on DataProviderAuthMethodUnsupported { | |
| authMethod | |
| supportedAuthMethods | |
| } | |
| ... on DataProviderConfigInvalid { | |
| message | |
| } | |
| ... on DataProviderConnected { | |
| connection { | |
| accountDisplayName | |
| accountIdentifier | |
| apiKeyLast4 | |
| authMethod | |
| availability | |
| clientId | |
| clientSecretLast4 | |
| connectionRole | |
| createdAt | |
| dataProviderId | |
| dataProviderSlug | |
| id | |
| organizationId | |
| scopes | |
| state | |
| updatedAt | |
| userId | |
| } | |
| } | |
| ... on DataProviderConnectionAuthMethodConflict { | |
| existingAuthMethod | |
| } | |
| } | |
| } |
| { | |
| "data": { | |
| "connectOrganizationDataProviderWithClientCredentials": { | |
| "__typename": "DataProviderAuthMethodUnsupported", | |
| "authMethod": "authMethod_example", | |
| "supportedAuthMethods": [ | |
| "supportedAuthMethods_example" | |
| ] | |
| } | |
| } | |
| } |
connectOrganizationDataProviderWithClientCredentials
Parameters ConnectOrganizationDataProviderWithClientCredentialsInput!
Returns ConnectDataProviderResult!
Write an organization-owned data provider’s configuration for the token’s organization: whether the organization’s shared connection is enabled, the scopes it requests, the organization’s own OAuth client credentials, and any non-secret configuration values the provider declares. Fields left out are unchanged.
GraphQL
| mutation SetOrganizationDataProviderConfiguration($input: SetOrganizationDataProviderConfigurationInput!) { | |
| setOrganizationDataProviderConfiguration(input: $input) { | |
| __typename | |
| ... on DataProviderConfigInvalid { | |
| message | |
| } | |
| ... on DataProviderConfiguration { | |
| availableScopes | |
| config { | |
| name | |
| value | |
| } | |
| dataProviderId | |
| dataProviderSlug | |
| enabled | |
| hasCredentials | |
| organizationId | |
| scopes | |
| updatedAt | |
| } | |
| } | |
| } |
| { | |
| "data": { | |
| "setOrganizationDataProviderConfiguration": { | |
| "__typename": "DataProviderConfigInvalid", | |
| "message": "message_example" | |
| } | |
| } | |
| } |
setOrganizationDataProviderConfiguration
Parameters SetOrganizationDataProviderConfigurationInput!
Returns SetDataProviderConfigurationResult!
Disconnect one of the token organization’s shared data provider connections, revoking the stored credentials for every member.
GraphQL
| mutation DeleteOrganizationDataProviderConnection($id: ID!) { | |
| deleteOrganizationDataProviderConnection(id: $id) | |
| } |
| { | |
| "data": { | |
| "deleteOrganizationDataProviderConnection": "deleteOrganizationDataProviderConnection_01EHWNCE74X7JSDV0X3SZ3KJNY" | |
| } | |
| } |