Gérer les destinations inter-comptes

Aperçu

Nous travaillons toujours sur cette fonctionnalité, mais nous aimerions que vous l'essayiez !

Cette fonctionnalité est actuellement fournie dans le cadre d'un programme d'aperçu conformément à nos politiques de pré-sortie.

Utilisez le NerdGraph API pour créer, tester, lister, mettre à jour et supprimer cross account destinations. Cross account destinations vous permettent de centraliser la gestion des notifications au niveau de l'organisation.

Créer une destination

Pour créer une destination, différentes entrées doivent être fournies pour chaque type de destination.

Important

Vous devez fournir un objet de portée identifiant où la destination sera créée. L'objet scope nécessite :

id : L'ID du compte ou de l'organisation.
type : Le type de périmètre (Compte ou Organisation).
Une propriété facultative two_way_integration est disponible pour les intégrations qui permettent une intégration bidirectionnelle.

Utilisez la mutation aiNotificationsCreateDestination pour créer une destination Jira qui s'intègre à votre instance Atlassian Jira afin de créer et gérer des tickets à partir des alertes New Relic.

Paramètres d'entrée

Nom du paramètre	Type de données	Description
`scope`	Objet	(Requis) Définit la portée dans laquelle la destination sera créée. Utilisez `type: ORGANIZATION` pour cross account destinations ou `type: ACCOUNT` pour les destinations au niveau du compte.
`scope.id`	Chaîne	(Requis) L'ID d'organisation pour cross account destinations ou l'ID de compte pour les destinations au niveau du compte.
`scope.type`	Énumération	(Requis) Doit être `ORGANIZATION` pour cross account destinations ou `ACCOUNT` pour les destinations au niveau du compte.
`destination.type`	Énumération	(Requis) Doit être `JIRA` pour les destinations Atlassian Jira.
`destination.name`	Chaîne	(Requis) Un nom descriptif pour la destination Jira.
`destination.auth`	Objet	(Requis) Configuration de l'authentification pour se connecter à votre instance Jira.
`destination.auth.type`	Énumération	(Requis) Doit être `BASIC` pour les intégrations Jira utilisant l'authentification par nom d'utilisateur et mot de passe/jeton d'API.
`destination.auth.basic`	Objet	(Requis) Contient les identifiants d'authentification Jira (e-mail et mot de passe/jeton d'API).
`destination.auth.basic.user`	Chaîne	(Obligatoire) Votre adresse e-mail de compte Jira.
`destination.auth.basic.password`	Chaîne	(Requis) Votre mot de passe de compte Jira ou votre jeton d'API. Par mesure de sécurité, utilisez un jeton d'API au lieu du mot de passe de votre compte.
`destination.properties`	éventail d'objets	(Requis) Propriétés de configuration incluant l'URL de l'instance Jira et les options d'intégration.
`destination.properties[].key: "url"`	Chaîne	(Requis) Doit inclure une propriété avec la clé "url" et la valeur définie sur l'URL de votre instance Jira (par ex. "https://yourcompany.atlassian.net").
`destination.properties[].key: "two_way_integration"`	Chaîne	(Facultatif) Définissez sur "true" pour activer l'intégration bidirectionnelle entre New Relic et Jira.

Exemple de requête pour un compte et une organisation :

mutation {
  aiNotificationsCreateDestination(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    destination: {
      type: JIRA
      name: "Destination Name"
      auth: {
        type: BASIC
        basic: { user: YOUR_EMAIL, password: YOUR_PASSWORD }
      }
      properties: [
        { key: "url", value: "https://YOUR_INSTANCE.atlassian.net" }
        { key: "two_way_integration", value: "true" }
      ]
    }
  ) {
    destination {
      id
      name
      scope {
        id
        type
      }
    }
  }
}

Exemple de requête pour une organisation :

mutation {
  aiNotificationsCreateDestination(
    scope: { id: YOUR_ORGANIZATION_ID, type: ORGANIZATION }
    destination: {
      type: JIRA
      name: "Destination Name"
      auth: {
        type: BASIC
        basic: { user: YOUR_EMAIL, password: YOUR_PASSWORD }
      }
      properties: [
        { key: "url", value: "https://YOUR_INSTANCE.atlassian.net" }
        { key: "two_way_integration", value: "true" }
      ]
    }
  ) {
    destination {
      id
      name
      scope {
        id
        type
      }
    }
  }
}

Utilisez la mutation aiNotificationsCreateDestination pour créer une destination e-mail afin d'envoyer des alertes de notification à des adresses e-mail.

Paramètres d'entrée

Nom du paramètre	Type de données	Description
`scope`	Objet	(Requis) Définit la portée dans laquelle la destination sera créée. Utilisez `type: ORGANIZATION` pour cross account destinations ou `type: ACCOUNT` pour les destinations au niveau du compte.
`scope.id`	Chaîne	(Requis) L'ID d'organisation pour cross account destinations ou l'ID de compte pour les destinations au niveau du compte.
`scope.type`	Énumération	(Requis) Doit être `ORGANIZATION` pour cross account destinations ou `ACCOUNT` pour les destinations au niveau du compte.
`destination.type`	Énumération	(Requis) Doit être `EMAIL` pour les destinations e-mail.
`destination.name`	Chaîne	(Requis) Un nom descriptif pour la destination de l'e-mail.
`destination.properties`	éventail d'objets	(Requis) Paires clé-valeur contenant la configuration de l'e-mail. Doit inclure une clé `email` avec l'adresse e-mail cible comme valeur.

Exemple de requête :

mutation {
  aiNotificationsCreateDestination(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    destination: {
      type: EMAIL
      name: "Destination Name"
      properties: [{ key: "email", value: YOUR_EMAIL }]
    }
  ) {
    destination {
      id
      name
      scope {
        id
        type
      }
    }
  }
}

Utilisez la mutation aiNotificationsCreateDestination pour créer une destination de webhook afin d'envoyer des requêtes HTTP POST vers des points de terminaison externes lorsque des alertes sont déclenchées.

Paramètres d'entrée

Nom du paramètre	Type de données	Description
`scope`	Objet	(Requis) Définit la portée dans laquelle la destination sera créée. Utilisez `type: ORGANIZATION` pour cross account destinations ou `type: ACCOUNT` pour les destinations au niveau du compte.
`scope.id`	Chaîne	(Requis) L'ID d'organisation pour cross account destinations ou l'ID de compte pour les destinations au niveau du compte.
`scope.type`	Énumération	(Requis) Doit être `ORGANIZATION` pour cross account destinations ou `ACCOUNT` pour les destinations au niveau du compte.
`destination.type`	Énumération	(Requis) Doit être `WEBHOOK` pour les destinations de webhook.
`destination.name`	Chaîne	(Requis) Un nom descriptif pour la destination du webhook.
`destination.auth`	Objet	(Facultatif) Configuration de l'authentification. Requis uniquement lorsque le point de terminaison du webhook nécessite une authentification.
`destination.auth.type`	Énumération	(Requis lorsque l'authentification est fournie) Méthode d'authentification. Options : `BASIC`, `TOKEN`.
`destination.auth.basic`	Objet	(Requis pour l'authentification BASIC et TOKEN) Contient les identifiants d'authentification tels que le nom d'utilisateur/mot de passe ou les informations de jeton.
`destination.properties`	éventail d'objets	(Requis) Paires clé-valeur contenant la configuration du webhook. Doit inclure la clé `url` avec l'URL du point de terminaison du webhook. `two_way_integration` facultatif pour la communication bidirectionnelle.

Exemple de requête :

mutation {
  aiNotificationsCreateDestination(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    destination: {
      type: WEBHOOK
      name: "Destination Name"
      auth: {
        type: BASIC
        basic: { user: YOUR_EMAIL, password: YOUR_PASSWORD }
      }
      properties: [
        { key: "url", value: YOUR_WEBHOOK }
        { key: "two_way_integration", value: "true" }
      ]
    }
  ) {
    destination {
      id
      name
      scope {
        id
        type
      }
    }
  }
}

Utilisez la mutation aiNotificationsCreateDestination pour créer une destination de niveau service PagerDuty qui s'intègre à un service PagerDuty spécifique à l'aide d'une clé d'intégration.

Paramètres d'entrée

Nom du paramètre	Type de données	Description
`scope`	Objet	(Requis) Définit la portée dans laquelle la destination sera créée. Utilisez `type: ORGANIZATION` pour cross account destinations ou `type: ACCOUNT` pour les destinations au niveau du compte.
`scope.id`	Chaîne	(Requis) L'ID d'organisation pour cross account destinations ou l'ID de compte pour les destinations au niveau du compte.
`scope.type`	Énumération	(Requis) Doit être `ORGANIZATION` pour cross account destinations ou `ACCOUNT` pour les destinations au niveau du compte.
`destination.type`	Énumération	(Requis) Doit être `PAGERDUTY_SERVICE_INTEGRATION` pour les destinations de niveau de service PagerDuty.
`destination.name`	Chaîne	(Requis) Un nom descriptif pour la destination de service PagerDuty.
`destination.auth`	Objet	(Requis) Configuration de l'authentification contenant la clé d'intégration PagerDuty.
`destination.auth.type`	Énumération	(Requis) Doit être `TOKEN` pour les intégrations de services PagerDuty.
`destination.auth.basic`	Objet	(Requis) Contient le jeton d'intégration et le préfixe pour l'authentification PagerDuty.
`destination.auth.basic.token`	Chaîne	(Requis) La clé d'intégration PagerDuty obtenue à partir de votre configuration de service PagerDuty.
`destination.auth.basic.prefix`	Chaîne	(Requis) Doit être `"Token token="` pour les intégrations de services PagerDuty.
`destination.properties`	éventail d'objets	(Facultatif) Propriétés de configuration supplémentaires. Peut être un tableau vide pour l'intégration de service de base.

Exemple de requête :

mutation {
  aiNotificationsCreateDestination(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    destination: {
      type: PAGERDUTY_SERVICE_INTEGRATION
      name: "Destination Name"
      auth: {
        type: TOKEN
        basic: { token: YOUR_INTEGRATION_TOKEN, prefix: "Token token=" }
      }
      properties: []
    }
  ) {
    destination {
      id
      name
      scope {
        id
        type
      }
    }
  }
}

Utilisez la mutation aiNotificationsCreateDestination pour créer une destination au niveau du compte PagerDuty qui s'intègre à l'ensemble de votre compte PagerDuty à l'aide d'une clé d'API, permettant des capacités de gestion des incidents plus étendues.

Paramètres d'entrée

Nom du paramètre	Type de données	Description
`scope`	Objet	(Requis) Définit la portée dans laquelle la destination sera créée. Utilisez `type: ORGANIZATION` pour cross account destinations ou `type: ACCOUNT` pour les destinations au niveau du compte.
`scope.id`	Chaîne	(Requis) L'ID d'organisation pour cross account destinations ou l'ID de compte pour les destinations au niveau du compte.
`scope.type`	Énumération	(Requis) Doit être `ORGANIZATION` pour cross account destinations ou `ACCOUNT` pour les destinations au niveau du compte.
`destination.type`	Énumération	(Requis) Doit être `PAGERDUTY_ACCOUNT_INTEGRATION` pour les destinations PagerDuty au niveau du compte.
`destination.name`	Chaîne	(Requis) Un nom descriptif pour la destination de compte PagerDuty.
`destination.auth`	Objet	(Requis) Configuration de l'authentification contenant la clé d'API du compte PagerDuty.
`destination.auth.type`	Énumération	(Requis) Doit être `TOKEN` pour les intégrations de compte PagerDuty.
`destination.auth.basic`	Objet	(Requis) Contient le jeton d'API et le préfixe pour l'authentification du compte PagerDuty.
`destination.auth.basic.token`	Chaîne	(Requis) La clé API du compte PagerDuty obtenue dans les paramètres de votre compte PagerDuty.
`destination.auth.basic.prefix`	Chaîne	(Requis) Doit être `"Token token="` pour les intégrations de compte PagerDuty.
`destination.properties`	éventail d'objets	(Facultatif) Propriétés de configuration pour l'intégration du compte. Propriété commune : `two_way_integration` définie sur "true" pour la communication bidirectionnelle.

Exemple de requête :

mutation {
  aiNotificationsCreateDestination(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    destination: {
      type: PAGERDUTY_ACCOUNT_INTEGRATION
      name: "Global PagerDuty Account"
      auth: {
        type: TOKEN
        basic: { token: YOUR_API_KEY, prefix: "Token token=" }
      }
      properties: [{ key: "two_way_integration", value: "true" }]
    }
  ) {
    destination {
      id
      name
      scope {
        id
        type
      }
    }
  }
}

La création d'une destination Slack inter-comptes dans New Relic nécessite une authentification OAuth entre le NerdGraph API et Slack. Les étapes suivantes expliquent comment générer l'URL d'authentification et terminer la configuration.

Générer l'URL OAuth

Ouvrez le NerdGraph Explorer et collez la requête suivante dans l'éditeur de requête. Cette requête génère une URL OAuth Slack unique pour votre organisation.

{
  actor {
    organization {
      aiNotifications {
        oAuthUrl(type: SLACK) {
          url
          transactionId
          error {
            description
            details
            type
          }
        }
      }
    }
  }
}

Cliquez sur Play (Execute Query) en haut de l'explorateur.

Accéder au lien d'authentification

Une fois la requête exécutée, vous verrez une réponse JSON contenant une URL sur le côté droit de l'écran.
Localisez le champ url dans la réponse.
Copiez l'intégralité de la chaîne URL (tout ce qui se trouve à l'intérieur des guillemets).
Ouvrez un nouvel onglet dans votre navigateur et collez l'URL.

Terminer l'autorisation Slack

Le lien vous dirige vers une page d'autorisation Slack.
Si vous y êtes invité, connectez-vous à l'espace de travail Slack que vous souhaitez connecter.
Vérifiez les autorisations demandées par New Relic.
Pour autoriser la connexion, cliquez sur Allow.
Vous devriez être redirigé vers une page New Relic « Success ».

Vérifier la destination

Une fois l'authentification OAuth réussie, la destination est automatiquement créée au niveau de l'organisation, ce qui la rend disponible pour tous les comptes de votre organisation.

Accédez à one.newrelic.com > Alerts > Destinations.
Dans la liste Destinations, vous devriez maintenant voir une nouvelle entrée pour l'espace de travail Slack que vous venez d'authentifier.

Utilisez la mutation aiNotificationsCreateDestination pour créer une destination ServiceNow qui s'intègre à votre instance ServiceNow pour créer et gérer des incidents à partir des alertes New Relic.

Paramètres d'entrée

Nom du paramètre	Type de données	Description
`scope`	Objet	(Requis) Définit la portée dans laquelle la destination sera créée. Utilisez `type: ORGANIZATION` pour cross account destinations ou `type: ACCOUNT` pour les destinations au niveau du compte.
`scope.id`	Chaîne	(Requis) L'ID d'organisation pour cross account destinations ou l'ID de compte pour les destinations au niveau du compte.
`scope.type`	Énumération	(Requis) Doit être `ORGANIZATION` pour cross account destinations ou `ACCOUNT` pour les destinations au niveau du compte.
`destination.type`	Énumération	(Requis) Doit être `SERVICE_NOW` pour les destinations ServiceNow.
`destination.name`	Chaîne	(Obligatoire) Un nom descriptif pour la destination ServiceNow.
`destination.auth`	Objet	(Requis) Configuration de l'authentification pour se connecter à votre instance ServiceNow.
`destination.auth.type`	Énumération	(Requis) Doit être `BASIC` pour les intégrations ServiceNow utilisant l'authentification par nom d'utilisateur et mot de passe.
`destination.auth.basic`	Objet	(Requis) Contient les identifiants d'authentification ServiceNow (nom d'utilisateur et mot de passe).
`destination.auth.basic.user`	Chaîne	(Requis) Votre nom d'utilisateur ou adresse e-mail du compte ServiceNow.
`destination.auth.basic.password`	Chaîne	(Requis) Le mot de passe de votre compte ServiceNow. Envisagez d'utiliser un compte de service pour une meilleure sécurité.
`destination.properties`	éventail d'objets	(Requis) Propriétés de configuration incluant l'URL de l'instance ServiceNow et les options d'intégration.
`destination.properties[].key: "url"`	Chaîne	(Requis) Doit inclure une propriété avec la clé "url" et la valeur définie sur l'URL de votre instance ServiceNow (par ex. "https://yourcompany.service-now.com").
`destination.properties[].key: "two_way_integration"`	Chaîne	(Facultatif) Définissez sur "true" pour activer l'intégration bidirectionnelle entre New Relic et ServiceNow.

Exemple de requête :

mutation {
  aiNotificationsCreateDestination(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    destination: {
      type: SERVICE_NOW
      name: "Destination Name"
      auth: {
        type: BASIC
        basic: { user: YOUR_EMAIL, password: YOUR_PASSWORD }
      }
      properties: [
        { key: "url", value: "https://YOUR_INSTANCE.service-now.com" }
        { key: "two_way_integration", value: "true" }
      ]
    }
  ) {
    destination {
      id
      name
      scope {
        id
        type
      }
    }
  }
}

Utilisez la mutation aiNotificationsCreateDestination pour créer une destination AWS EventBridge qui envoie des événements d'alerte New Relic vers votre AWS EventBridge pour un traitement et un routage ultérieurs au sein de votre écosystème AWS.

Paramètres d'entrée

Nom du paramètre	Type de données	Description
`scope`	Objet	(Requis) Définit la portée dans laquelle la destination sera créée. Utilisez `type: ORGANIZATION` pour cross account destinations ou `type: ACCOUNT` pour les destinations au niveau du compte.
`scope.id`	Chaîne	(Requis) L'ID d'organisation pour cross account destinations ou l'ID de compte pour les destinations au niveau du compte.
`scope.type`	Énumération	(Requis) Doit être `ORGANIZATION` pour cross account destinations ou `ACCOUNT` pour les destinations au niveau du compte.
`destination.type`	Énumération	(Requis) Doit être `EVENT_BRIDGE` pour les destinations AWS EventBridge.
`destination.name`	Chaîne	(Requis) Un nom descriptif pour la destination AWS EventBridge.
`destination.auth`	Objet	(Requis) Configuration de l'authentification pour se connecter à AWS EventBridge à l'aide des identifiants IAM.
`destination.auth.type`	Énumération	(Requis) Doit être `BASIC` pour les intégrations AWS EventBridge utilisant des identifiants d'utilisateur IAM.
`destination.auth.basic`	Objet	(Requis) Contient les identifiants d'authentification AWS IAM (ID de clé d'accès et clé d'accès secrète).
`destination.auth.basic.user`	Chaîne	(Requis) Votre ID de clé d'accès AWS IAM. Assurez-vous que l'utilisateur IAM dispose des autorisations EventBridge.
`destination.auth.basic.password`	Chaîne	(Requis) Votre clé d'accès secrète AWS IAM. Stockez-le en toute sécurité et envisagez d'utiliser des rôles IAM lorsque cela est possible.
`destination.properties`	éventail d'objets	(Requis) Propriétés de configuration incluant l'ID de compte AWS et la région pour EventBridge.
`destination.properties[].key: "AWSAccountId"`	Chaîne	(Requis) Doit inclure une propriété avec la clé "AWSAccountId" et la valeur définie sur votre ID de compte AWS (numéro à 12 chiffres).
`destination.properties[].key: "AWSRegion"`	Chaîne	(Requis) Doit inclure une propriété avec la clé "AWSRegion" et une valeur définie sur votre région AWS (par ex. "us-east-1", "eu-west-1").

Exemple de requête :

mutation {
  aiNotificationsCreateDestination(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    destination: {
      type: EVENT_BRIDGE
      name: "Destination Name"
      auth: {
        type: BASIC
        basic: { user: YOUR_IAM_USER, password: YOUR_PASSWORD }
      }
      properties: [
        { key: "AWSAccountId", value: YOUR_AWS_ACCOUNT_ID }
        { key: "AWSRegion", value: YOUR_AWS_REGION }
      ]
    }
  ) {
    destination {
      id
      name
      scope {
        id
        type
      }
    }
  }
}

Tester une destination inter-comptes

Vous pouvez tester cross account destinations avant ou après la création. Vous devez fournir l'objet de portée.

Utilisez la mutation aiNotificationsTestDestination pour tester une configuration de destination avant de la créer. Cela vous permet de valider les paramètres et les identifiants sans créer réellement la destination.

Paramètres d'entrée

Nom du paramètre	Type de données	Description
`scope`	Objet	(Requis) Définit le périmètre du test. Utilisez `type: ORGANIZATION` pour cross account destinations ou `type: ACCOUNT` pour les destinations au niveau du compte.
`scope.id`	Chaîne	(Requis) L'ID d'organisation pour cross account destinations ou l'ID de compte pour les destinations au niveau du compte.
`scope.type`	Énumération	(Requis) Doit être `ORGANIZATION` pour cross account destinations ou `ACCOUNT` pour les destinations au niveau du compte.
`destination`	Objet	(Requis) L'objet de configuration de destination à tester, incluant le type, le nom, l'authentification et les propriétés.
`destination.type`	Énumération	(Requis) Le type de destination à tester. Options : `EMAIL`, `WEBHOOK`, `PAGERDUTY_SERVICE_INTEGRATION`, `PAGERDUTY_ACCOUNT_INTEGRATION`, `SLACK`, `JIRA`, `SERVICE_NOW`, `EVENT_BRIDGE`.
`destination.name`	Chaîne	(Requis) Un nom pour la configuration de destination en cours de test.
`destination.auth`	Objet	(Facultatif) Configuration de l'authentification pour les destinations nécessitant des identifiants. Requis pour les destinations WEBHOOK, PAGERDUTY, JIRA, SERVICE_NOW et EVENT_BRIDGE.
`destination.properties`	éventail d'objets	(Requis) Paires clé-valeur qui configurent les paramètres spécifiques à la destination tels que les URL, les adresses e-mail ou les options d'intégration.

Exemple de requête :

mutation {
  aiNotificationsTestDestination(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    destination: {
      type: EMAIL
      name: "Destination Name"
      properties: [{ key: "email", value: YOUR_EMAIL }]
    }
  ) {
    error {
      details
    }
    details
    result
  }
}

Utilisez la mutation aiNotificationsTestDestinationById pour tester une destination existante par son ID. Cela vérifie que la destination est correctement configurée et qu'elle peut envoyer des notifications avec succès.

Paramètres d'entrée

Nom du paramètre	Type de données	Description
`scope`	Objet	(Requis) Définit la portée dans laquelle la destination existe. Utilisez `type: ORGANIZATION` pour cross account destinations ou `type: ACCOUNT` pour les destinations au niveau du compte.
`scope.id`	Chaîne	(Requis) L'ID d'organisation pour cross account destinations ou l'ID de compte pour les destinations au niveau du compte.
`scope.type`	Énumération	(Requis) Doit être `ORGANIZATION` pour cross account destinations ou `ACCOUNT` pour les destinations au niveau du compte.
`destinationId`	Chaîne	(Requis) L'identifiant unique de la destination existante que vous souhaitez tester. Cet identifiant est renvoyé lors de la création d'une destination ou peut être trouvé en listant les destinations.

Exemple de requête :

mutation {
  aiNotificationsTestDestinationById(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    destinationId: YOUR_DESTINATION_ID
  ) {
    error {
      details
    }
    details
    result
  }
}

Lister et filtrer les destinations

La requête destinations vous permet de paginer parmi toutes vos destinations aux niveaux du compte et de l'organisation. Il permet également la fonctionnalité de filtrage pour cross account destinations.

Utilisez la requête actor.organization.aiNotifications.destinations pour récupérer toutes les destinations au niveau de l'organisation, y compris cross account destinations qui peuvent être utilisées dans tous les comptes de l'organisation.

Paramètres d'entrée

Cette requête utilise le contexte GraphQL actor.organization et ne nécessite pas de paramètres d'entrée explicites. La requête renvoie automatiquement toutes les destinations accessibles au niveau de l'organisation.

Champ de requête	Type de données	Description
`actor`	Objet	Objet de requête racine représentant le contexte de l'utilisateur authentifié.
`organization`	Objet	Contexte de l'organisation qui donne accès aux ressources au niveau de l'organisation et à cross account destinations.
`aiNotifications`	Objet	Contexte du service de notifications IA pour accéder aux ressources liées aux notifications.
`destinations`	Objet	Champ de requête qui renvoie toutes les destinations accessibles au niveau de l'organisation, y compris cross account destinations.

Exemple de requête :

{
  actor {
    organization {
      aiNotifications {
        destinations {
          entities {
            id
            name
            scope {
              id
              type
            }
          }
          error {
            details
          }
        }
      }
    }
  }
}

Utilisez la requête actor.account.aiNotifications.destinations pour récupérer toutes les destinations accessibles à un compte spécifique, y compris les destinations au niveau du compte et cross account destinations disponibles pour ce compte.

Paramètres d'entrée

Nom du paramètre	Type de données	Description
`account.id`	Chaîne/ID	(Requis) L'ID de compte spécifique pour lequel récupérer les destinations. Ce compte doit être accessible à l'utilisateur authentifié.

Champs de requête

Champ de requête	Type de données	Description
`actor`	Objet	Objet de requête racine représentant le contexte de l'utilisateur authentifié.
`account`	Objet	Contexte de compte qui fournit un accès aux ressources spécifiques au compte et aux cross account destinations disponibles pour ce compte.
`aiNotifications`	Objet	Contexte du service de notifications IA pour accéder aux ressources liées aux notifications.
`destinations`	Objet	Champ de requête qui renvoie toutes les destinations accessibles au compte spécifié (à la fois au niveau du compte et de l'organisation).

Exemple de requête :

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        destinations {
          entities {
            id
            name
            scope {
              id
              type
            }
          }
          error {
            details
          }
        }
      }
    }
  }
}

Utilisez la pagination par curseur pour naviguer efficacement dans de grands ensembles de destinations. Vous devez demander le champ nextCursor dans votre requête pour activer la pagination.

Paramètres d'entrée

Nom du paramètre	Type de données	Description
`account.id`	Chaîne/ID	(Requis) L'ID de compte spécifique pour lequel récupérer les destinations. Ce compte doit être accessible à l'utilisateur authentifié.
`destinations.cursor`	Chaîne	(Facultatif) Curseur pour la pagination. Utilisez la chaîne vide `""` pour la première requête, puis utilisez la valeur `nextCursor` des réponses précédentes pour obtenir les pages suivantes.

Workflow de pagination

Avec la pagination par curseur, vous continuez à effectuer des requêtes sur l'ensemble de résultats jusqu'à ce que le nextCursor renvoyé par la réponse soit vide. Cela signifie que vous avez atteint la fin de vos résultats.

Voici un exemple pour un compte (la même logique s'applique à une organisation) :

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        destinations(cursor: "") {
          nextCursor
          entities {
            id
            name
            scope {
              id
              type
            }
          }
          totalCount
        }
      }
    }
  }
}

Le code ci-dessus renvoie un ensemble de résultats comme celui-ci :

{
  "data": {
    "actor": {
      "account": {
        "aiNotifications": {
          "destinations": {
            "nextCursor": "/8o0y2qiR54m6thkdgHgwg==:jZTXDFKbTkhKwvMx+CtsPVM=",
            "entities": [
              {
                "id": "01c0cbe7-3d70-47c1-99e0-adf906eed6c2",
                "name": "Destination Name",
                "scope": {
                  "type": "ACCOUNT",
                  "id": "312312"
                }
              },
              {
                "id": "05db0207-c137-4985-8cb5-f21e7e57b8cc",
                "name": "Another Destination Name",
                "scope": {
                  "type": "ACCOUNT",
                  "id": "312312"
                }
              }
            ],
            "totalCount": 807
          }
        }
      }
    }
  }
}

Ainsi, dans votre requête suivante, fournissez le curseur comme ceci, jusqu'à ce que le curseur soit vide :

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        destinations(
          cursor: "/8o0y2qiR54m6thkdgHgwg==:jZTXDFKbTkhKwvMx+CtsPVM="
        ) {
          nextCursor
          entities {
            id
            name
            scope {
              id
              type
            }
          }
          totalCount
        }
      }
    }
  }
}

Voici un autre exemple pour une organisation

{
  actor {
    organization {
      aiNotifications {
        destinations(cursor: "") {
          nextCursor
          entities {
            id
            name
            scope {
              id
              type
            }
          }
          totalCount
        }
      }
    }
  }
}

Le code ci-dessus renvoie un ensemble de résultats comme celui-ci :

{
  "data": {
    "actor": {
      "organization": {
        "aiNotifications": {
          "destinations": {
            "nextCursor": "/8o0y2qiR54m6thkdgHgwg==:jZTXDFKbTkhKwvMx+CtsPVM=",
            "entities": [
              {
                "id": "01c0cbe7-3d70-47c1-99e0-adf906eed6c2",
                "name": "Destination Name",
                "scope": {
                  "type": "ORGANIZATION",
                  "id": "01ddcbe7-3d70-47c1-99e0-adf906eed6c2"
                }
              },
              {
                "id": "05db0207-c137-4985-8cb5-f21e7e57b8cc",
                "name": "Another Destination Name",
                "scope": {
                  "type": "ORGANIZATION",
                  "id": "01ddcbe7-3d70-47c1-99e0-adf906eed6c2"
                }
              }
            ],
            "totalCount": 807
          }
        }
      }
    }
  }
}

Ainsi, dans votre requête suivante, fournissez le curseur comme ceci, jusqu'à ce que le curseur soit vide :

{
  actor {
    organization {
      aiNotifications {
        destinations(
          cursor: "/8o0y2qiR54m6thkdgHgwg==:jZTXDFKbTkhKwvMx+CtsPVM="
        ) {
          nextCursor
          entities {
            id
            name
            scope {
              id
              type
            }
          }
          totalCount
        }
      }
    }
  }
}

Utilisez le filtrage par nom pour rechercher des destinations par leur nom. Le filtre de nom prend en charge les correspondances exactes et partielles, et est insensible à la casse.

Paramètres d'entrée

Nom du paramètre	Type de données	Description
`account.id`	Chaîne/ID	(Requis) L'ID de compte spécifique pour lequel récupérer les destinations. Ce compte doit être accessible à l'utilisateur authentifié.
`destinations.filters`	Objet	(Requis) Objet de critères de filtrage pour affiner les résultats.
`destinations.filters.name`	Chaîne	(Requis) Filtrer par nom de destination. Prend en charge les correspondances partielles et est insensible à la casse. Renvoie les destinations dont le nom contient la chaîne spécifiée.

Exemple de requête :

Cet exemple trouve les destinations dont le nom contient "DevOps" :

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        destinations(filters: { name: "DevOps" }) {
          entities {
            id
            name
            scope {
              id
              type
            }
          }
        }
      }
    }
  }
}

Utilisez le filtrage par ID pour récupérer une destination spécifique via son identifiant unique. Ce filtre renvoie uniquement des correspondances exactes.

Paramètres d'entrée

Nom du paramètre	Type de données	Description
`account.id`	Chaîne/ID	(Requis) L'ID de compte spécifique pour lequel récupérer les destinations. Ce compte doit être accessible à l'utilisateur authentifié.
`destinations.filters`	Objet	(Requis) Objet de critères de filtrage pour spécifier la destination exacte à récupérer.
`destinations.filters.id`	Chaîne	(Requis) Filtrer par ID de destination. Renvoie la destination avec l'ID correspondant exactement, si elle existe et est accessible au compte spécifié.

Exemple de requête :

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        destinations(filters: { id: YOUR_DESTINATION_ID }) {
          entities {
            id
            name
            scope {
              id
              type
            }
          }
        }
      }
    }
  }
}

Utilisez le filtrage par type pour récupérer les destinations d'un type spécifique. Ce filtre renvoie toutes les destinations qui correspondent au type de destination spécifié.

Paramètres d'entrée

Nom du paramètre	Type de données	Description
`account.id`	Chaîne/ID	(Requis) L'ID de compte spécifique pour lequel récupérer les destinations. Ce compte doit être accessible à l'utilisateur authentifié.
`destinations.filters`	Objet	(Requis) Objet de critères de filtrage pour affiner les résultats par type de destination.
`destinations.filters.type`	Énumération	(Requis) Filtrer par type de destination. Valeurs valides : `EMAIL`, `WEBHOOK`, `PAGERDUTY_SERVICE_INTEGRATION`, `PAGERDUTY_ACCOUNT_INTEGRATION`, `SLACK`, `JIRA`, `SERVICE_NOW`, `EVENT_BRIDGE`.

Exemple de requête :

La requête suivante renverra toutes les destinations d'e-mail sur le compte choisi :

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        destinations(filters: { type: EMAIL }) {
          entities {
            id
            name
            scope {
              id
              type
            }
          }
        }
      }
    }
  }
}

Mettre à jour une destination inter-comptes

Pour mettre à jour un cross-account destination existant, vous devez fournir le périmètre de l'organisation et l'ID de destination.

Utilisez la mutation aiNotificationsUpdateDestination pour mettre à jour un cross-account destination existant.

Paramètres d'entrée

Nom du paramètre	Type de données	Description
`scope`	Objet	(Requis) Définit la portée dans laquelle la destination existe. Utilisez `type: ORGANIZATION` pour cross account destinations ou `type: ACCOUNT` pour les destinations au niveau du compte.
`scope.id`	Chaîne	(Requis) L'ID d'organisation pour cross account destinations ou l'ID de compte pour les destinations au niveau du compte.
`scope.type`	Énumération	(Requis) Doit être `ORGANIZATION` pour cross account destinations ou `ACCOUNT` pour les destinations au niveau du compte.
`destinationId`	Chaîne	(Requis) L'identifiant unique de la destination que vous souhaitez mettre à jour. Cet identifiant est renvoyé lors de la création d'une destination ou peut être trouvé en listant les destinations.
`destination`	Objet	(Requis) L'objet de mise à jour de la destination contenant les champs que vous souhaitez modifier. Incluez uniquement les champs que vous souhaitez modifier.
`destination.name`	Chaîne	(Facultatif) Nom mis à jour de la destination.
`destination.auth`	Objet	(Facultatif) Configuration de l'authentification mise à jour pour les destinations nécessitant des identifiants.
`destination.properties`	éventail d'objets	(Facultatif) Paires clé-valeur mises à jour pour les paramètres spécifiques à la destination, tels que les URL, les adresses e-mail ou les options d'intégration.

Exemple de requête :

mutation {
  aiNotificationsUpdateDestination(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    destinationId: YOUR_DESTINATION_ID
    destination: { name: "Updated destination Name" }
  ) {
    destination {
      id
      name
      scope {
        id
        type
      }
    }
  }
}

Supprimer une destination inter-comptes

Supprimez cross account destinations en fournissant le scope et le destination ID.

Important

Avant de supprimer: Si vous recevez une erreur indiquant "Le type d'entité canal est en cours d'utilisation", vous devez d'abord supprimer tous les canaux associés à la destination. Trouvez les canaux associés et supprimez-les individuellement avant de procéder à la suppression de la destination.

Utilisez la mutation aiNotificationsDeleteDestination pour supprimer définitivement un cross account destination.

Paramètres d'entrée

Nom du paramètre	Type de données	Description
`scope`	Objet	(Requis) Définit la portée dans laquelle la destination existe. Utilisez `type: ORGANIZATION` pour cross account destinations ou `type: ACCOUNT` pour les destinations au niveau du compte.
`scope.id`	Chaîne	(Requis) L'ID d'organisation pour cross account destinations ou l'ID de compte pour les destinations au niveau du compte.
`scope.type`	Énumération	(Requis) Doit être `ORGANIZATION` pour cross account destinations ou `ACCOUNT` pour les destinations au niveau du compte.
`destinationId`	Chaîne	(Requis) L'identifiant unique de la destination que vous souhaitez supprimer. Cet identifiant est renvoyé lors de la création d'une destination ou peut être trouvé en listant les destinations.

Exemple de requête :

mutation {
  aiNotificationsDeleteDestination(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    destinationId: YOUR_DESTINATION_ID
  ) {
    ids
    error {
      details
    }
  }
}

Utilisez cette requête pour trouver tous les canaux qui utilisent actuellement une destination spécifique. Cela est utile avant de supprimer une destination pour s'assurer qu'aucun canal actif ne sera affecté.

Paramètres d'entrée

Nom du paramètre	Type de données	Description
`account.id`	Chaîne/ID	(Requis) L'ID de compte spécifique pour rechercher des canaux. Ce compte doit être accessible à l'utilisateur authentifié.
`channels.filters`	Objet	(Requis) Objet de critères de filtrage pour trouver des canaux utilisant une destination spécifique.
`channels.filters.destinationId`	Chaîne	(Requis) L'identifiant unique de la destination à rechercher. Renvoie tous les canaux configurés pour utiliser cette destination.

Exemple de requête :

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        channels(filters: { destinationId: YOUR_DESTINATION_ID }) {
          entities {
            id
            name
          }
        }
      }
    }
  }
}

Utilisez la mutation aiNotificationsDeleteChannel pour supprimer les canaux qui utilisent une destination. Vous devez supprimer tous les canaux associés avant de pouvoir supprimer la destination elle-même.

Paramètres d'entrée

Nom du paramètre	Type de données	Description
`accountId`	Chaîne/ID	(Requis) L'ID de compte où le canal existe. Ce compte doit être accessible à l'utilisateur authentifié.
`channelId`	Chaîne	(Requis) L'identifiant unique du canal que vous souhaitez supprimer. Cet identifiant peut être trouvé en interrogeant les canaux à l'aide de l'identifiant de destination.

Exemple de requête :

mutation {
  aiNotificationsDeleteChannel(
    accountId: YOUR_ACCOUNT_ID
    channelId: "YOUR_CHANNEL_ID"
  ) {
    ids
    error {
      details
    }
  }
}

Prochaines étapes

Vue d'ensemble des destinations inter-comptes

En savoir plus sur les concepts et les fonctionnalités clés de cross account destinations.

Cette traduction automatique est fournie pour votre commodité.

Aperçu

Créer une destination .css-21sua1{background:none;border:none;width:0;padding:0;}

Important

Créer une destination e-mail

Créer une destination de webhook

Créer une destination PagerDuty au niveau du service

Créer une destination PagerDuty au niveau du compte

Créer une destination Slack

Créer une destination ServiceNow

Créer une destination AWS EventBridge

Tester une destination inter-comptes

Tester la configuration de la destination

Tester la destination existante par ID

Lister et filtrer les destinations

Lister toutes les destinations inter-comptes pour une organisation

Lister les destinations pour un compte spécifique

Pagination par destinations avec pagination du curseur

Filtrer les destinations par nom

Filtrer les destinations par ID

Filtrer les destinations par type

Mettre à jour une destination inter-comptes

Mettre à jour une destination inter-comptes

Supprimer une destination inter-comptes

Important

Supprimer une destination inter-comptes

Trouver des canaux utilisant une destination

Supprimer les canaux associés

Prochaines étapes

Vue d'ensemble des destinations inter-comptes

Créer une destination