query · Module: Integrations
Arguments
Returns
Integration!
Errors
Errors are returned inerrors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
query Integration($id: ID!) {
integration(id: $id) {
id
object
name
status
kind
connection_methods {
type
label
issuer
authorization_endpoint
token_endpoint
openid
}
federated {
configuration
}
pricing {
model
documentation
}
}
}
{
"id": "obj_1a2B3c"
}
{
"data": {
"integration": {
"id": "obj_1a2B3c",
"object": "integration",
"name": "Example",
"status": "available",
"kind": "carrier",
"connection_methods": [
{
"type": "credentials",
"label": "Example",
"issuer": "https://ada.okta.com/oauth2/default",
"authorization_endpoint": "example",
"token_endpoint": "example",
"openid": true
}
],
"federated": {
"configuration": "example"
},
"pricing": {
"model": "example",
"documentation": "example"
}
}
}
}
Retrieve an integration
query Integration($id: ID!) {
integration(id: $id) {
id
object
name
status
kind
connection_methods {
type
label
issuer
authorization_endpoint
token_endpoint
openid
}
federated {
configuration
}
pricing {
model
documentation
}
}
}
{
"id": "obj_1a2B3c"
}
{
"data": {
"integration": {
"id": "obj_1a2B3c",
"object": "integration",
"name": "Example",
"status": "available",
"kind": "carrier",
"connection_methods": [
{
"type": "credentials",
"label": "Example",
"issuer": "https://ada.okta.com/oauth2/default",
"authorization_endpoint": "example",
"token_endpoint": "example",
"openid": true
}
],
"federated": {
"configuration": "example"
},
"pricing": {
"model": "example",
"documentation": "example"
}
}
}
}
query · Module: Integrations
| Argument | Type | Description |
|---|---|---|
id | ID! | The object’s ID. |
Integration!
| Field | Type |
|---|---|
id | String! |
object | IntegrationObject! |
name | String! |
kind | IntegrationKind! |
interfaces | JSON! |
connection_methods | [ConnectionMethod!] |
config_schema | JsonSchema |
federated | IntegrationFederated |
pricing | IntegrationPricing |
status | IntegrationStatus |
errors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
query Integration($id: ID!) {
integration(id: $id) {
id
object
name
status
kind
connection_methods {
type
label
issuer
authorization_endpoint
token_endpoint
openid
}
federated {
configuration
}
pricing {
model
documentation
}
}
}
{
"id": "obj_1a2B3c"
}
{
"data": {
"integration": {
"id": "obj_1a2B3c",
"object": "integration",
"name": "Example",
"status": "available",
"kind": "carrier",
"connection_methods": [
{
"type": "credentials",
"label": "Example",
"issuer": "https://ada.okta.com/oauth2/default",
"authorization_endpoint": "example",
"token_endpoint": "example",
"openid": true
}
],
"federated": {
"configuration": "example"
},
"pricing": {
"model": "example",
"documentation": "example"
}
}
}
}