Utiliser SCIM 2.0 avec Showpad

SCIM est une norme ouverte largement acceptée conçue pour faciliter la gestion des identités d'utilisateurs dans les services et applications cloud. Le SCIM dispose d'un ensemble de contrats par défaut pour les utilisateurs et les groupes qui peut être élargi.

Notre mise en œuvre du SCIM cible la version 2.0 du protocole.
Liens utiles :

• Norme ouverte SCIM
• Spécifications SCIM 2.0

Cet article traite de la mise en œuvre du SCIM dans Showpad.

Accéder au SCIM

Il faut considérer la mise en œuvre du SCIM comme une extension de l'API publique de Showpad. L'accès se fait via l'authentification du porteur.

Ce qu'il vous faut pour réussir

• Forfait Showpad Enterprise
• Compte administrateur Showpad
• Un système de gestion d'identité tiers 

Les clés de cet outil génial

• Points de terminaison
• Commandes basiques
• Méthodes SCIM 2.0
• Commandes de groupe

Points de terminaison

Le point de terminaison de référence de l'API est :

https://{sous-domaine de l'organisation}.showpad.biz/api/users/scim/v2

Chaque demande suivante doit être précédée du point de terminaison de référence.

Commandes basiques

GET /Schemas

Affiche les données de configuration.
Vous pouvez également les obtenir séparément :

• GET /Schemas/urn:ietf:params:scim:schemas:core:2.0:User
• GET /Schemas/urn:ietf:params:scim:schemas:core:2.0:Group
• GET /Schemas/urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

GET /ResourceTypes

Affiche les types de ressources.
Vous pouvez également les obtenir séparément :

• GET /ResourceTypes/User
• GET /ResourceTypes/Group

GET /ServiceProviderConfig

Affiche une liste des opérations prises en charge dans la mise en œuvre actuelle

User (utilisateur)

« User » cartographie des attributs SCIM à un utilisateur Showpad. Vous pouvez répertorier, filtrer, ajouter, modifier ou supprimer des utilisateurs.

Attributes (attributs)

Les attributs tels que phoneNumbers, emails et rolessont multivalués dans le SCIM mais uniques dans Showpad. Lorsque vous créez ou remplacez un utilisateur et spécifiez plusieurs valeurs, la valeur principale sera cartographiée et les autres valeurs seront supprimées. S'il n'y a pas de valeur principale, c'est la première valeur qui sera utilisée.

groups est un attribut en lecture seule. Cela vous permet de voir à quels groupes d'utilisateurs un utilisateur appartient. La modification de l'appartenance d'un utilisateur à un groupe doit être gérée via la ressource Usergroup.

enterprise dans le tableau correspond au schéma d'entreprise urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Les attributs emails[0].valueet username doivent être uniques dans le système. Sinon, vous obtiendrez une erreur uniqueness .

emails[0].valuedoit correspondre au schéma d'une adresse e-mail.

Un nouvel utilisateur sera automatiquement affecté au groupe « Tous les utilisateurs ». C'est un groupe par défaut auquel vous ne pouvez pas annuler l'affectation de l'utilisateur. Si vous souhaitez affecter l'utilisateur à un autre groupe, il doit déjà exister ou être créé via le point de terminaison « Groups ».

Lorsque vous modifiez roles[0].value,sachez que seuls certains rôles sont pris en charge dans le système :

• owner (voir remarque) 
• admin
• manager
• tablet, un rôle par défaut

Remarque : Un seul propriétaire est autorisé dans le système. Vous obtiendrez une erreur uniqueness si vous essayez d'en créer un autre.

Entitlements (droits)

 Lorsqu'un utilisateur a le rôle de manager , il peut être affecté à des groupes dont il peut coacher les utilisateurs. L'affectation de ces groupes peut se faire au niveau de la section entitlements en utilisant :

"entitlements": [
 {
 "value": "22b3d7f8eea74c37d3d140642ccbaeba",
 "type": "coach_for_group" 
 }
]

Méthodes SCIM 2.0

POST /Users

Cette commande crée un utilisateur. 

POST {{url}}/Users
Accept: application/json
Authorization: Bearer {{token}}
Host: {{host}}

{
  "active": true,
  "emails": [
    {
      "primary": true,
      "type": "work",
      "value": "john.doe@showpad.com" 
    }
  ],
  "locale": "en",
  "name": {
    "familyName": "Doe",
    "givenName": "John" 
  },
  "entitlements": [
    {
        "value": "22b3d7f8eea74c37d3d140642ccbaeba",
        "type": "coach_for_group" 
    }
  ],
  "roles": [
    {
      "value": "manager" 
    }
  ],
  "timezone": "Europe/Brussels",
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User" 
  ],
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "organization": "John Doe's org" 
  },
  "userName": "john.doe@showpad.com" 
}

Get /Users/{Id}

Cette commande affiche un utilisateur avec l'identifiant donné.

GET {{url}}/Users/{id}
Accept: application/json
Authorization: Bearer {{token}}
Host: {{host}}

GET {{url}}/Users?startIndex=11&count;=10&filter;=username%20eq%20%22john.doe@showpad.com%22
Accept: application/json
Authorization: Bearer {{token}}
Host: {{host}}

PUT {{url}}/Users/{id}
Accept: application/json
Authorization: Bearer {{token}}
Host: {{host}}

{
  "emails": [
    {
      "value": "john.doe.second@showpad.com" 
    }
  ],
  "name": {
    "familyName": "Doe Second",
    "givenName": "John" 
  },
  "userName": "john-doe-second" 
}

DELETE {{url}}/Users/{id}
Accept: application/json
Authorization: Bearer {{token}}
Host: {{host}}

POST {{url}}/Groups
Accept: application/json
Authorization: Bearer {{token}}
Host: {{host}}

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
  "displayName": "SCIM test group",
  "members": [
    {
      "value": "abcdefgh123456789"
    },
    {
      "value": "123456789abcdefgh"
    }
  ]
}

GET {{url}}/Groups/{id}
Accept: application/json
Authorization: Bearer {{token}}
Host: {{host}}

GET {{url}}/Groups?startIndex=11&count;=10" 
Accept: application/json
Authorization: Bearer {{token}}
Host: {{host}}

PUT {{url}}/Groups/{id}
Accept: application/json
Authorization: Bearer {{token}}
Host: {{host}}

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
  "displayName": "SCIM test group change",
  "members": [
    {
      "value": "abcdefgh123456789"
    },
    {
      "value": "123456789abcdefgh"
    }
  ]

DELETE {{url}}/Groups/{id}
Accept: application/json
Authorization: Bearer {{token}}
Host: {{host}}