Gestion automatisée des utilisateurs : APISCIM

Pour configurer le provisionnement et la gestion de votre utilisateur New Relic à partir d'un fournisseur d'identité, nous fournissons une API SCIM pour les fournisseurs d'identité qui ne disposent pas déjà d'applications et d'implémentations spécifiquesNew Relic.

Qui devrait utiliser l’API SCIM ?

Si vous disposez d’un fournisseur d’identité disposant d’une application New Relic (Azure AD, Okta et OneLogin), consultez les guides correspondants. L'API SCIM est destinée aux organisations qui n'utilisent pas ces fournisseurs d'identité ou qui souhaitent utiliser l'API SCIM pour configuration supplémentaire non disponible avec les applications (par exemple, managing user type). Restrictions supplémentaires :

Avant d'utiliser notre API SCIM, vous devez d'abord configurer un domaine d'authentification avec SCIM activé. L'UI du domaine d'authentification vous fournira des valeurs que vous pourrez utiliser pour intégrer votre fournisseur d'identité.

Notez qu'après avoir configuré une intégration avec l'API SCIM, il y a d'autres étapes à suivre, notamment la rétrogradation de certains utilisateurs en utilisateurs de base et l'octroi aux groupes d'utilisateurs de l'accès aux comptes New Relic.

Notre tutoriel sur l'API SCIM

Ce document contient des informations techniques sur notre API SCIM. Pour des instructions détaillées sur son utilisation, consultez le didacticiel de l'API SCIM.

SCIM prestataire de services

Notre prestataire de services SCIM suit l'API SCIM 2.0 telle que décrite dans les RFC 7643 et 7644. Vous n’avez pas besoin d’implémenter tous les aspects de la spécification SCIM 2.0 pour intégrer vos informations utilisateur à New Relic. En fait, le fournisseur de services New Relic lui-même n’implémente pas tous les aspects de la spécification. Ce document décrit les fonctionnalités de la spécification disponibles pour une intégration avec New Relic.

Authentification

L'authentification nécessite un jeton porteur. Ce jeton porteur est spécifique à votre domaine d'authentification New Relic et s'affiche lors de la première activation de SCIM pour un domaine d'authentification.

Ressources prises en charge

Le prestataire de services New Relic prend en charge les ressources SCIM suivantes : Group , User , Service provider config , Resource type et Schema. Bulk et Search ne sont pas pris en charge. Pour plus d'informations sur la manière dont la RFC décrit le point de terminaison de ressource, consultez la spécification du protocole SCIM RFC 7644.

Schémas

New Relic utilise un sous-ensemble des champs disponibles dans le schéma de base SCIM. Les autres champs SCIM sont ignorés s'ils sont inclus dans requests entrantes. Les champs utilisés par New Relic sont :

Group:

Nom du champ SCIM	Description
`displayName`	Required. Nom du groupe.
`members`	Liste des utilisateurs du groupe.

User:

Nom du champ SCIM	Description
`externalId`	Identifiant unique de l'utilisateur utilisé par votre système.
`userName`	Required. Identifiant unique de l'utilisateur au sein du système New Relic. Utilisez l'adresse e-mail de l'utilisateur.
`name.familyName`	Nom de famille de l'utilisateur.
`name.givenName`	Prénom de l'utilisateur.
`emails` ou `emails.value`	Required. Adresse email de l'utilisateur.
`timezone`	Fuseau horaire de l'utilisateur au format de base de données de fuseaux horaires IANA, également connu sous le nom de format de base de données de fuseaux horaires « Olson » (par exemple, « America/Los_Angeles »).
`active`	Required. Booléen indiquant si l'utilisateur doit être actif ou inactif dans New Relic.
`groups`	Liste des groupes auxquels appartient l'utilisateur.

Schéma de type d'utilisateur New Relic (de base, de base ou complet)

Il s'agit d'une extension de schéma facultative pour l'attribut utilisateur spécifique à New Relic. Actuellement, cela permet de contrôler uniquement le type d'utilisateur d'un utilisateur. Pour un didacticiel montrant comment l'utiliser, consultez le didacticiel de l'API SCIM.

urn:ietf:params:scim:schemas:extension:newrelic:2.0:User:

Nom du champ SCIM	Description
`nrUserType`	Le type d'utilisateur: `Full User`, `Core User` ou `Basic User`.

Actions soutenues

SCIM fournit plusieurs options pour manipuler les groupes et les utilisateurs. Le prestataire de services New Relic prend en charge les options suivantes.

Lors de la configuration, sachez que :

Seul le filtrage simple est pris en charge. L'opérateur eq peut être utilisé avec une expression de filtre de base. Par exemple, “displayName eq "Example Group 1”. Les autres opérateurs ne sont pas pris en charge.
PUT les mises à jour ne nécessitent pas que tous les champs soient inclus. Les champs qui ne sont pas inclus ne seront pas modifiés. Lorsque vous effectuez un PUT, si un champ obligatoire possède déjà la valeur appropriée, il n'est pas nécessaire d'inclure le champ.

Les actions prises en charge sont :

Exemple de demande :

POST /Groups

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "displayName": "Example Group 1",
  "members": []
}

Exemple de réponse :

201 Created

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "id": "d0652232-b14f-434d-9c6f-36de7e1ab010",
  "displayName": "Example Group 1",
  "meta": {
    "resourceType": "Group",
    "created": "2019-11-08T21:33:13.055Z",
    "lastModified": "2019-11-08T21:33:13.055Z"
  },
  "members": []
}

Exemple de demande :

GET /Groups/YOUR_GROUP_ID

Exemple de réponse :

200 OK

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "id": "d0652232-b14f-434d-9c6f-36de7e1ab010",
  "displayName": "Example Group 1",
  "meta": {
    "resourceType": "Group",
    "created": "2019-11-08T21:33:13.055Z",
    "lastModified": "2019-11-08T21:33:13.055Z"
  },
  "members": []
}

Exemple de demande :

GET /Groups?filter=displayName eq "Example Group 1"

Exemple de réponse :

200 OK

{
  "totalResults": 1,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [{
    "schemas": [
      "urn:ietf:params:scim:schemas:core:2.0:Group"
    ],
    "id": "d0652232-b14f-434d-9c6f-36de7e1ab010",
    "displayName": "Example Group 1",
    "meta": {
      "resourceType": "Group",
      "created": "2019-11-08T21:33:13.055Z",
      "lastModified": "2019-11-08T21:33:13.055Z"
    },
    "members": []
  }]
}

Dans la demande, incluez les champs que vous souhaitez modifier. Si vous incluez le champ members , l'utilisateur du groupe sera ajusté pour correspondre au contenu du champ membres. Exemple de demande :

PUT /Groups/YOUR_GROUP_ID

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "displayName": "Example Group 1a"
}

Exemple de réponse :

200 OK

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "id": "d0652232-b14f-434d-9c6f-36de7e1ab010",
  "displayName": "Example Group 1a",
  "meta": {
    "resourceType": "Group",
    "created": "2019-11-08T21:33:13.055Z",
    "lastModified": "2019-11-08T22:47:14.019Z"
  },
  "members": []
}

Exemple de demande :

PATCH /Groups/YOUR_GROUP_ID

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [{
    "op": "Replace",
    "path": "displayName",
    "value": "Example Group 1b"
  }]
}

Exemple de réponse :

204 No Content

Exemple de demande :

PATCH /Groups/YOUR_GROUP_ID

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [{
    "op": "Add",
    "path": "members",
    "value": [{
      "value": "f0cbc276-16c9-4d1a-abc0-1856b0c74224"
    }]
  }]
}

Exemple de réponse :

204 No Content

Exemple de demande :

PATCH /Groups/YOUR_GROUP_ID

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [{
    "op": "Remove",
    "path": "members",
    "value": [{
      "value": "f0cbc276-16c9-4d1a-abc0-1856b0c74224"
    }]
  }]
}

Exemple de réponse :

204 No Content

Exemple de demande :

POST /Users

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "externalId": "external-id-1",
  "userName": "example-user-1@example.com",
  "name": {
    "familyName": "User 1",
    "givenName": "Example"
  },
  "emails": [{
    "value": "example-user-1@example.com",
    "primary": true
  }],
  "timezone": "America/Los_Angeles",
  "active": true,
  "groups": []
}

Exemple de réponse :

201 Created

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id": "f0cbc276-16c9-4d1a-abc0-1856b0c74224",
  "externalId": "external-id-1",
  "userName": "example-user-1@example.com",
  "name": {
    "familyName": "User 1",
    "givenName": "Example"
  },
  "emails": [{
    "value": "example-user-1@example.com",
    "primary": true
  }],
  "timezone": "America/Los_Angeles",
  "active": true,
  "meta": {
    "resourceType": "User",
    "created": "2019-11-08T22:07:12.477Z",
    "lastModified": "2019-11-08T22:07:12.477Z"
  },
  "groups": []
}

Exemple de demande :

GET /Users/YOUR_USER_ID

Exemple de réponse :

200 OK

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id": "f0cbc276-16c9-4d1a-abc0-1856b0c74224",
  "externalId": "external-id-1",
  "userName": "example-user-1@example.com",
  "name": {
    "familyName": "User 1",
    "givenName": "Example"
  },
  "emails": [{
    "value": "example-user-1@example.com",
    "primary": true
  }],
  "timezone": "America/Los_Angeles",
  "active": true,
  "meta": {
    "resourceType": "User",
    "created": "2019-11-08T22:07:12.477Z",
    "lastModified": "2019-11-08T22:07:12.477Z"
  },
  "groups": []
}

Exemple de demande :

GET /Users?filter=externalId eq "external-id-1"

Exemple de réponse :

200 OK

{
  "totalResults": 1,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [{
    "schemas": [
      "urn:ietf:params:scim:schemas:core:2.0:User"
    ],
    "id": "f0cbc276-16c9-4d1a-abc0-1856b0c74224",
    "externalId": "external-id-1",
    "userName": "example-user-1@example.com",
    "name": {
      "familyName": "User 1",
      "givenName": "Example"
    },
    "emails": [{
      "value": "example-user-1@example.com",
      "primary": true
    }],
    "timezone": "America/Los_Angeles",
    "active": true,
    "meta": {
      "resourceType": "User",
      "created": "2019-11-08T22:07:12.477Z",
      "lastModified": "2019-11-08T22:07:12.477Z"
    },
    "groups": []
  }]
}

Dans la demande, incluez les champs que vous souhaitez modifier. Si vous incluez le champ groups , les groupes de l'utilisateur seront ajustés pour correspondre au contenu du champ groupes. Exemple de demande :

PUT /Users/YOUR_USER_ID

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "name": {
    "familyName": "User 1A",
    "givenName": "Example"
  }
}

Exemple de réponse :

200 OK

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id": "f0cbc276-16c9-4d1a-abc0-1856b0c74224",
  "externalId": "external-id-1",
  "userName": "example-user-1@example.com",
  "name": {
    "familyName": "User 1A",
    "givenName": "Example"
  },
  "emails": [{
    "value": "example-user-1@example.com",
    "primary": true
  }],
  "timezone": "America/Los_Angeles",
  "active": true,
  "meta": {
    "resourceType": "User",
    "created": "2019-11-08T22:07:12.477Z",
    "lastModified": "2019-11-08T22:28:33.552Z"
  },
  "groups": []
}

Exemple de demande :

PATCH /Users/YOUR_USER_ID

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [{
    "op": "Replace",
    "path": "active",
    "value": "false"
  }]
}

Exemple de réponse :

204 No Content

déviation par rapport à la RFC

Cette section décrit les domaines dans lesquels le prestataire de services SCIM New Relic s'écarte du protocole SCIM RFC 7644. Les numéros de section font référence aux numéros de section RFC.

Les éléments de cette section pourraient changer à mesure que nous travaillons à mettre notre prestataire de services en totale conformité avec la RFC.

Nom de la section RFC	Numéro de section RFC	description de l'écart
Créer des ressources	3.3.	Le champ `meta.location` n'est pas défini.
Filtration	3.4.2.2.	Le seul opérateur actuellement pris en charge est `eq`. Les noms de champs sont sensibles à la casse. Les attributs de chaîne sont comparés en respectant la casse. La préfixation du nom du champ avec le schéma n'est pas prise en charge. Par exemple, `filter=urn:ietf:params:scim:schemas:core:2.0:User:userName eq "johnsmith"` ne fonctionnera pas.
`/Me` Alias de sujet authentifié	3.11.	`GET` avec la ressource `/Me` renvoie un `404 Not Found`.
Prestataire de services configuration point de terminaison	4.	Le prestataire de services fonctionnalité découverte point de terminaison ne prend pas en charge le filtrage.
Considérations sur les jetons porteurs et les cookies	7.4.	Les jetons au porteur n'ont pas de date d'expiration définie.

Étapes suivantes lorsque vous avez terminé

Prochaines étapes :

Ajustez le type d'utilisateur de votre utilisateur

Lorsque vos utilisateurs sont provisionnés dans New Relic, vous pouvez les voir dans l'UIUser management .

Si vous ajoutez un utilisateur à New Relic via SCIM mais que vous ne gérez pas son type d'utilisateur via SCIM, ils commencent comme utilisateur de base. Pour mettre à niveau utilisateur, vous avez deux options :

Utilisez l'UI de gestion des utilisateurs.
Utilisez l'API SCIM pour gérer le type d'utilisateur.

Attribuer un accès au groupe

Une fois que vos utilisateurs sont dans New Relic, vous devez leur accorder l'accès à des comptes New Relic spécifiques, à des groupes spécifiques et à des rôles spécifiques. Sans cela, votre utilisateur n'aura pas accès aux comptes New Relic. Pour savoir comment procéder, consultez :

Configurer SAML SSO

Si vous souhaitez configurer SAML SSO, ce que font la plupart des utilisateurs SCIM, consultez la documentation SAML SSO .

Cette traduction automatique est fournie pour votre commodité.

Gestion automatisée des utilisateurs : APISCIM

Qui devrait utiliser l’API SCIM ?

Notre tutoriel sur l'API SCIM

SCIM prestataire de services

Authentification

Ressources prises en charge

Schémas

Schéma de type d'utilisateur New Relic (de base, de base ou complet)

Actions soutenues

Créer un groupe

Obtenir un groupe

Obtenir un groupe par requête

Mettre à jour le groupe avec PUT

Mettre à jour le groupe avec PATCH (champs non membres)

Mettre à jour le groupe avec PATCH (Ajouter des membres)

Mettre à jour le groupe avec PATCH (Supprimer des membres)

Supprimer le groupe

Créer un utilisateur

Obtenir l'utilisateur

Obtenir l'utilisateur par requête

Mettre à jour l'utilisateur avec PUT

Mettre à jour l'utilisateur avec PATCH

Supprimer l'utilisateur

déviation par rapport à la RFC

Étapes suivantes lorsque vous avez terminé

Ajustez le type d'utilisateur de votre utilisateur

Attribuer un accès au groupe

Configurer SAML SSO

Cette traduction automatique est fournie pour votre commodité.

Gestion automatisée des utilisateurs : APISCIM

Qui devrait utiliser l’API SCIM ? .css-21sua1{background:none;border:none;width:0;padding:0;}

Notre tutoriel sur l'API SCIM

SCIM prestataire de services

Authentification

Ressources prises en charge

Schémas

Schéma de type d'utilisateur New Relic (de base, de base ou complet)

Actions soutenues

Obtenir un groupe

Obtenir un groupe par requête

Mettre à jour le groupe avec PUT

Mettre à jour le groupe avec PATCH (champs non membres)

Mettre à jour le groupe avec PATCH (Ajouter des membres)

Mettre à jour le groupe avec PATCH (Supprimer des membres)

Supprimer le groupe

Créer un utilisateur

Obtenir l'utilisateur

Obtenir l'utilisateur par requête

Mettre à jour l'utilisateur avec PUT

Mettre à jour l'utilisateur avec PATCH

Supprimer l'utilisateur

déviation par rapport à la RFC

Étapes suivantes lorsque vous avez terminé

Ajustez le type d'utilisateur de votre utilisateur

Attribuer un accès au groupe

Configurer SAML SSO

Qui devrait utiliser l’API SCIM ?