Gestion des identités SmartSense avec SCIM v2
Afin de faciliter la gestion des utilisateurs de SmartSense, SmartSense propose un ensemble de points de terminaison conformes à la norme SCIM version 2.
Pagination des résultats
Conformément à la RFC 7644 du SCIM, tout point de terminaison renvoyant une liste de données est soumis à la pagination. Les informations de pagination sont incluses dans toutes les réponses paginées comme suit.
Nom | Type | Description |
totalResults | Nombre total de résultats correspondant à la requête du client. | |
startIndex | L'index (à partir de 1) du premier résultat de la page actuelle. | |
nombre d'éléments par page | Nombre de résultats affichés sur la page actuelle. |
Types spécifiques à SCIM
Les objets SCIM et leurs attributs sont définis par la spécification RFC 7643 relative au SCIM. Vous trouverez ci-dessous une description des types SCIM utilisés dans l'implémentation SCIM de SmartSense, ainsi que leur mode d'utilisation.
Meta
Tous les objets SCIM contiennent un méta-objet. Cet objet n'est pas obligatoire pour les requêtes PUT, POST ou PATCH, mais il est toujours renvoyé lors des requêtes GET.
Nom | Type | Mutabilité | Description |
type de ressource | chaîne de caractères | Lecture seule | Le nom du type de la ressource contenue. |
emplacement | chaîne de caractères | Lecture seule | Une URL permettant d'effectuer une requête GET sur l'objet. |
Utilisateur SmartSense Enterprise
SmartSenseEnterpriseUser (désormais obsolète et plus nécessaire, mais qui reste à jour pour des raisons de compatibilité ascendante) est une extension du schéma de base SCIM « Enterprise User ». SmartSenseEnterpriseUser se compose de deux attributs.
Nom | Type | Mutabilité | Description |
defaultContactRoleId | chaîne de caractères | Lecture-Écriture | Un ContactRoleId qui sera utilisé lors de l'affectation de l'utilisateur à un groupe. |
Nom
Nom | Type | Mutabilité | Description |
prénom | chaîne de caractères | Lecture-Écriture | Le prénom de l'utilisateur. |
nom de famille | chaîne de caractères | Lecture-Écriture | Le nom de famille de l'utilisateur. |
Nom | Type | Mutabilité | Description |
valeur | chaîne de caractères | Lecture-Écriture | L'adresse e-mail de l'utilisateur. |
type | chaîne de caractères | Lecture-Écriture | Le type d'adresse e-mail. Il doit toujours s'agir d'une adresse « professionnelle ». |
primaire | booléen | Lecture-Écriture | Valeur booléenne indiquant si cette adresse e-mail est l'adresse principale de l'utilisateur. Doit toujours être « true ». |
Numéro de téléphone
Les utilisateurs de SmartSense peuvent être configurés avec deux numéros de téléphone : un pour les appels vocaux et un pour les SMS. Le « type » d'un numéro de téléphone destiné aux SMS doit être défini sur « SMS ». Le « type » d'un numéro de téléphone destiné aux appels vocaux doit être défini sur « voix ».
Nom | Type | Mutabilité | Description |
valeur | chaîne de caractères | Lecture-Écriture | Le numéro de téléphone de l'utilisateur. 1 |
type | chaîne de caractères | Lecture-Écriture | Le type d'adresse de numéro de téléphone. Il doit s'agir soit de « SMS », soit de « voix ». |
primaire | booléen | Lecture-Écriture | Valeur booléenne indiquant si ce numéro de téléphone est le numéro principal de l'utilisateur. Doit toujours être « true ». |
Remarque : formats de numéros de téléphone acceptés :
- E.164: `+11234567890`
- RFC3966: `tel:+11234567890` ou `tel:+1-123-456-7890`
-*Format international: `+1(123)456-7890,` `+1-123-456-7890,` `+1.123.456.7890,` ou `1 123 456 7890`
- Format national:`123-456-7890,` `123.456.7890,` `(123)456-7890,` ou `123 456 7890`
*Siun numéro international respecte le même format qu'un numéro national, il sera enregistré comme un numéro américain précédé du préfixe « +1 »
Quel que soit le format d'entrée, SmartSense enregistre tous les numéros de téléphone au format E.164 et les renvoie sous la forme « +11234567890 ».
Les formats de numéros de téléphone non valides ne seront pas enregistrés.
Fonction du contact
Les points de terminaison « Contact Role » permettent de créer et de mettre à jour des rôles de contact à partir du système SmartSense. Les rôles de contact définissent la relation qu'entretient un utilisateur avec un groupe. Lorsqu'un utilisateur est affecté à un groupe, un rôle de contact doit également lui être attribué. Ces rôles de contact servent à déterminer qui doit être averti lorsqu'un actif passe en état d'alarme.
Il est possible d'attribuer un seul rôle de contact à un utilisateur pour tous les groupes auxquels il appartient, en définissant le champ `DefaultContactRoleId` dans l'objet ` SmartSenseEnterpriseUser `.
Modèle d'objet « ContactRole »
Nom | Type | Mutabilité | Description |
id | chaîne de caractères | Lecture seule | Identifiant unique au niveau mondial du ContactRole. |
nom | chaîne de caractères | Immuable | Le nom du rôle de contact qui s'affiche dans l'application SmartSense. |
Attribut « Type de groupe »
Créer et récupérer les attributs de type de groupe configurés pour votre compte. Dans SmartSense, il est possible de définir des attributs pour les groupes. Les différents types de groupes (GroupTypes) possèdent des attributs obligatoires et facultatifs qui varient en fonction du modèle de groupe (GroupTemplate) qui leur est attribué. Ces attributs servent à l'organisation au sein de l'application SmartSense.
Modèle d'objet GroupTypeAttribute
Nom | Type | Mutabilité | Description |
attributeID | chaîne de caractères | Lecture seule | Un identifiant unique pour l'attribut. |
nom_de_l'attribut | chaîne de caractères | Lecture seule | Le nom de l'attribut qui s'affiche dans l'application SmartSense. |
type d'attribut | chaîne de caractères | Lecture seule | Nom du type de données de l'attribut. |
isRequired | booléen | Lecture seule | Une valeur booléenne indiquant si les groupes de ce type doivent fournir une valeur pour cet attribut. |
type de groupe | chaîne de caractères | Lecture seule | Le type de groupe auquel appartient l'attribut. |
Groupes
Les points de terminaison « Groups » permettent de créer, de mettre à jour et de supprimer des groupes dans le système SmartSense, ainsi que de gérer les utilisateurs qui leur sont associés. Dans SmartSense, les groupes sont organisés en une arborescence hiérarchique en fonction de leur « GroupType ». Les groupes servent à organiser les actifs, et les utilisateurs sont affectés à des groupes via un « ContactRole ». Le schéma SCIM des groupes est défini par la section 4.2 de la norme RFC 7643.
Modèle d'objet de groupe
SmartSense exploite tous les attributs du modèle du groupe SCIM et l'étend.
Nom | Type | Mutabilité | Description |
id | chaîne de caractères | Lecture seule | Un identifiant unique au monde pour le groupe. |
externalid | chaîne de caractères | Lecture-Écriture | Identifiant fourni par le client. Cet attribut n'est pas utilisé par l'application SmartSense et sert uniquement à des fins de suivi externe. |
parentid | chaîne de caractères | Immuable | L'identifiant de la société mère du groupe. |
displayName | chaîne de caractères | Lecture-Écriture | Nom du groupe tel qu'il apparaît dans l'application SmartSense. |
type | Immuable | Le profil du groupe. | |
attributs | tableau | Lecture-Écriture | Liste des attributs associés au groupe. |
membres | tableau | Lecture-Écriture | Liste des utilisateurs appartenant au groupe. Voir « Membres ». |
méta | Lecture seule | Les métadonnées relatives au groupe. |
Modèle d'objets des membres
Nom | Type | Mutabilité | Description |
soupape | chaîne de caractères | Immuable | L'identifiant du membre. Il doit s'agir d'un identifiant utilisateur valide. |
contactRoleId | chaîne de caractères | Immuable | Le ContactRoleId du membre du groupe. |
type | chaîne de caractères | Immuable | Le type de l'objet membre. |
$ref | chaîne de caractères | Immuable | Une référence d'URL permettant d'effectuer une requête GET pour récupérer le membre. |
Type de ressource
Récupérez les types de ressources SCIM correspondant aux ressources définies par SmartSense. Les types de ressources SCIM sont définis et requis par la section 6 de la norme RFC 7643.
Modèle d'objet ResourceType
Nom | Type | Mutabilité | Description |
id | chaîne de caractères | Lecture seule | Un identifiant pour le ResourceType. |
nom | chaîne de caractères | Lecture seule | Le nom de la ressource. |
description | chaîne de caractères | Lecture seule | Une description de la ressource. |
point de terminaison | chaîne de caractères | Lecture seule | Le critère d'évaluation principal permettant de récupérer les ressources de ce « ResourceType ». |
schéma | chaîne de caractères | Lecture seule | Le schéma de base « ResourceTypes ». |
extension de schéma | Lecture seule | Une liste des schémas qui étendent le schéma de base du type de ressource. | |
méta | Lecture seule | Les métadonnées relatives au ResourceType. |
Modèle d'objet SchemaExtension
Nom | Type | Mutabilité | Description |
schéma | chaîne de caractères | Lecture seule | L'extension de schéma en cours d'application. |
obligatoire | booléen | Lecture seule | Il faut déterminer si l'extension doit être appliquée lors de l'interaction avec le système. |
Utilisateurs
Les points de terminaison « Users » permettent de créer, de mettre à jour et de supprimer des utilisateurs du système SmartSense. Les utilisateurs SmartSense créés via l'API SCIM ne peuvent se connecter au système SmartSense que par le biais d'une intégration SAML SSO. SmartSense n'utilise qu'un sous-ensemble des attributs utilisateur SCIM disponibles. Le schéma complet des utilisateurs SCIM est défini dans la section 4.1 de la norme RFC 7643.
Modèle d'objet utilisateur
Nom | Type | Mutabilité | Description |
id | chaîne de caractères | Lecture seule | Un identifiant unique au monde attribué à l'utilisateur. |
externalid | chaîne de caractères | Lecture-Écriture | Identifiant fourni par le client. Cet attribut n'est pas utilisé par l'application SmartSense et sert uniquement à des fins de suivi externe. |
nom d'utilisateur | chaîne de caractères | Immuable | Un identifiant unique sous forme de chaîne de caractères attribué à l'utilisateur. |
actif | booléen | Lecture-Écriture | Une valeur booléenne indiquant si l'utilisateur est autorisé à accéder au système. |
type d'utilisateur | AccessRole | Lecture-Écriture | Une chaîne de caractères identifiant les autorisations de l'utilisateur dans le système. |
nom | Lecture-Écriture | Un objet complexe contenant le prénom et le nom de l'utilisateur. | |
e-mails | tableau | Lecture-Écriture | Une liste d'adresses e-mail. SmartSense n'accepte et ne renvoie qu'une seule adresse e-mail de cette liste. |
numéros de téléphone | tableau | Lecture-Écriture | Une liste de numéros de téléphone. SmartSense prend en charge deux types de numéros de téléphone : les numéros SMS et les numéros vocaux. |
groupes | tableau | Lecture seule | Liste des groupes auxquels l'utilisateur appartient. |
méta | Lecture seule | Les métadonnées de l'utilisateur. |
Documentation interactive de l'API
Pour consulter la documentation détaillée sur les points de terminaison et pouvoir tester directement les appels API, rendez-vous sur notre documentation Swagger :
L'interface Swagger propose :
Schémas de requête et de réponse
Tests interactifs des API