REST API
L’ensemble des fonctionnalités de Relution est disponible via une API REST complète. Cette API permet de contrôler Relution depuis toute autre application ou à l’aide de scripts.
Documentation de l’API
Chaque serveur Relution embarque la spécification complète de l’API, correspondant exactement à la version installée du serveur. Elle documente tous les points de terminaison avec leurs paramètres, les corps de requête et de réponse ainsi que les codes de statut retournés.
La spécification s’ouvre depuis le portail Relution : l’entrée API Web du menu de support (en haut à droite) ouvre la documentation interactive. Elle est également accessible directement à l’adresse https://<serveur>/web-api/index.html.
Les requêtes adressées à l’API REST sont soumises aux mêmes contrôles de permissions que les actions effectuées dans le portail ; les actions liées à la sécurité sont consignées dans le Journal d’audit →.
Créer des jetons d’accès à l’API
Pour accéder à Relution depuis des systèmes tiers ou des scripts, un jeton d’accès API est nécessaire.
- Cliquer sur le nom d’utilisateur en haut à droite du portail Relution.
- Naviguer vers :
Profil→Jeton d’accès→Ajouter un jeton d’accès. - Donner un nom au jeton et le copier.
Le jeton est utilisé dans l’en-tête HTTP X-User-Access-Token pour authentifier les requêtes.
Scripts d’exemple
1. Utilisateurs au format CSV
- La première ligne du fichier
.csvdoit contenir une ligne d’en-tête avec les noms des propriétés souhaitées. - L’ordre des colonnes n’a pas d’importance.
- Les propriétés non nécessaires peuvent être omises.
- Champs obligatoires :
userid,email,first name,last name,password
Les mots de passe doivent respecter la politique définie sous Paramètres → Politique de mot de passe. Les numéros de téléphone doivent être au format international, par ex. +4912345.
Il est possible d’ajouter jusqu’à 15 propriétés personnalisées :
custom1 – custom15
👉 Un modèle peut être téléchargé dans le portail Relution :
Utilisateurs → Utilisateurs → Menu trois points → Importer des utilisateurs via CSV → Télécharger le modèle
Exemple CSV :
name,email,givenName,surName,password,phone,position,country,managedAppleId,custom1,custom2
user1,user1@company.com,Heinz,Ketchup,p4ssw0rd,+49234346345,user1 position,user1 country,user1.id@company.com,43,Operations
user2,user2@company.com,Heinz,Ketchup,p4ssw0rd,+49234346345,user2 position,user2 country,user2.id@company.com,24,Marketing
user3,user3@company.com,Heinz,Ketchup,p4ssw0rd,+49234346345,user3 position,user3 country,user3.id@company.com,30,RH
user4,user4@company.com,Heinz,Ketchup,p4ssw0rd,+49234346345,user4 position,user4 country,user4.id@company.com,32,Ventes
user5,user5@company.com,Heinz,Ketchup,p4ssw0rd,+49234346345,user5 position,user5 country,user5.id@company.com,45,Finance
user6,user6@company.com,Heinz,Ketchup,p4ssw0rd,+49234346345,user6 position,user6 country,user6.id@company.com,30,Achats
2. Importer des utilisateurs via le portail Relution
- Aller dans :
Utilisateurs→Utilisateurs→Menu trois points→Importer des utilisateurs via CSV - Sélectionner le fichier CSV et le séparateur.
- Assigner les utilisateurs importés à un ou plusieurs groupes.
- Les utilisateurs apparaîtront ensuite dans l’aperçu.
3. Créer des utilisateurs via l’API Relution
Changement dans Relution 5.34 :
- L’import d’utilisateurs est désormais un job en arrière-plan avec les états (RUNNING / FINISHED).
- Chaque job enregistre un rapport par ligne.
- L’ancien import a été supprimé.
- Certains noms de colonnes ont changé :
first name→givenNamelast name→surNamemanaged apple id→managedAppleIdphone number→phoneuserId→name
Étapes
Créer un fichier
users.csv.Copier le script bash suivant dans un fichier, par ex.
uploadUserCSV.sh.Rendre le fichier exécutable :
chmod +x ./uploadUserCSV.shL’exécuter :
./uploadUserCSV.sh -f 'FILEPATH' -h 'HOST' -a 'YOUR-ACCESS-TOKEN' -u 'ORGANIZATION_UUID'
Arguments
| Argument | Signification | Exemple | Défaut | Obligatoire |
|---|---|---|---|---|
-f | Chemin vers le fichier users.csv | user.csv | ✅ | |
-h | Hôte Relution | https://relution.io | ✅ | |
-a | Jeton d’accès API | xxxxxxxx | ✅ | |
-u | UUID de l’organisation | 01995C17-6BD0-7F84-87E9-21A1498B386F | ✅ | |
-r | Rôles attribués aux utilisateurs | Organame%20Device%20User | ❌ | |
-s | Séparateur utilisé pour le parsing | SEMICOLON | COMMA | ❌ |
-w | Écraser les utilisateurs existants | true | false | ❌ |
Exemple de sortie
============
success: 1, skipped: 1, failed: 1
2: [SUCCESS] User ... successfully stored with version 1.
3: [FAILED] Number of data fields does not match number of headers.
4: [SKIPPED] User Test2 should not be overwritten.
4. Importer des utilisateurs via script Bash CSV
Show full configuration example
#!/bin/bash
set -e
# --------------------------------------------------------------------------------
while getopts "a:h:f:u:w:r:s:" opt; do
case $opt in
a) # apikey
ACCESS_TOKEN="$OPTARG"
;;
h) # host
HOST="$OPTARG"
;;
f) # File
FILE="$OPTARG"
;;
u) # organization uuid
ORGANIZATION_UUID="$OPTARG"
;;
w) # Overwrite
OVERWRITE="$OPTARG"
;;
r) # Role
ROLE="$OPTARG"
;;
s) # Separator
SEPARATOR="$OPTARG"
;;
\?)
echo "Unknown option -$OPTARG" >&2
;;
esac
done
if [[ -z ACCESS_TOKEN ]]; then
echo "Please specify an access token (-a)"
exit 1
fi
if [[ -z $HOST ]]; then
echo "Please specify a Host URL (-h)"
exit 1
fi
if [[ ! -f $FILE ]]; then
echo "Please specify an existing csv file (-f)"
exit 1
fi
if [[ -z $ORGANIZATION_UUID ]]; then
echo "Please specify an organization uuid (-o)"
exit 1
fi
if [[ -z $SEPARATOR ]]; then
SEPARATOR="COMMA"
fi
if [[ -z $OVERWRITE ]]; then
OVERWRITE=false
fi
if [[ -z $ROLE ]]; then
ROLE=Organame%20Device%20User
fi
call() {
# Create a temporary file for the response body
tmpfile=$(mktemp) || { echo "Failed to create temp file" >&2; exit 1; }
http_code=$(curl -sw "%{http_code}" -o "$tmpfile" -H "Accept: application/json" -H "X-User-Access-Token: $ACCESS_TOKEN" "$@")
content=$(cat "$tmpfile")
rm -f "$tmpfile"
if [[ "$http_code" != "200" && "$http_code" != "201" ]]; then
echo "fail: $http_code" >&2
echo $content >&2
exit 1
fi
# Output the content for capture
printf "%s" "$content"
}
echo "Will start importing users to '${ORGANIZATION_UUID}' on server '${HOST} as '${ROLE//%20/ }'".
echo "Using '$FILE' with separator of type '$SEPARATOR'."
echo "Next step: uploading file"
upload=$(call -F "file=@$FILE;type=text/csv" "$HOST/api/management/v1/csvImport/upload/users")
file_uuid=$(echo "$upload" | jq -r '.results[0].uuid')
echo "Done uploading file: $file_uuid"
echo "============"
echo "Next step: start import job"
job=$(call -X POST "$HOST/api/management/v1/security/users/import/fromFile/$file_uuid?overwrite=$OVERWRITE&role=$ROLE&csvSeparator=$SEPARATOR")
job_uuid=$(echo "$job" | jq -r '.uuid')
echo "Job started: $job_uuid"
job_status=""
while [[ "$job_status" != "FINISHED" && "$job_status" != "FAILED" ]]; do
sleep 1
job=$(call -X GET "$HOST/api/management/v1/csvImport/job/$job_uuid")
job_status=$(echo "$job" | jq -r '.results[0].status')
echo "Job status: $job_status"
done
echo "============"
success_count=$(echo "$job" | jq -r '.results[0].successCount')
skipped_count=$(echo "$job" | jq -r '.results[0].skippedCount')
failure_count=$(echo "$job" | jq -r '.results[0].failureCount')
echo "success: $success_count, skipped: $skipped_count, failed: $failure_count"
if [[ "$failure_count" -ne 0 ]]; then
query='{"sortOrder":{"sortFields":[{"name":"line","ascending":true}]}}'
report=$(call -X POST -H "Content-Type: application/json" --data "$query" "$HOST/api/management/v1/csvImport/job/$job_uuid/entityStates/query")
reports=$(echo $report | jq -c '.results')
echo "$reports" | jq -c '.[]' | while read -r item; do
line=$(echo "$item" | jq -r '.line')
status=$(echo "$item" | jq -r '.status')
message=$(echo "$item" | jq -r '.message')
echo "$line: [$status] $message"
done
fi
5. Créer une nouvelle organisation
Show full configuration example
#!/bin/bash
#--------------------------------------------------------------------------------
# Web service URL, change the server name as needed
SVR_URL="https://<myserver>/api/management/v1/security/organizations/creationWizardRequests"
# Access token of System Admin, create it by opening https://<server>/#/profile
# Open this URL in your browser while logged in as System Administrator.
# NOTE: This is not an URL you can reach through clicking through the portal!
ACCESS_TOKEN="<sysadmin_api_token>"
# HTTP Headers
ACCEPT="application/json"
ACCEPT_CHARSET="UTF-8"
# Query example
read -r -d '' JSON_BODY << 'EOF'
{
"limit": 10,
"offset": 0,
"getNonpagedCount": true,
"sortOrder": {
"sortFields": [
{
"name": "lastConnectionDate",
"ascending": false
}
]
},
"filter": {
"type": "logOp",
"operation": "AND",
"filters": [
{
"type": "stringEnum",
"fieldName": "platform",
"values": [
"ANDROID",
"ANDROID_ENTERPRISE",
"IOS"
]
},
{
"type": "stringEnum",
"fieldName": "status",
"values": [
"COMPLIANT",
"INACTIVE"
]
}
]
}
}
EOF
echo "Querying devices at $SVR_URL..."
echo
# No changes should be required beyond this line...
RESPONSE=$(curl -X POST \
${SVR_URL}${FILTER} \
-H "X-User-Access-Token: $ACCESS_TOKEN" \
-H "Accept: $ACCEPT" \
-H "Accept-Charset: $ACCEPT_CHARSET" \
-H "Content-Type: $ACCEPT" \
--write-out " HTTP_STATUS=%{http_code}" \
--silent \
-d "$JSON_BODY")
if [[ $RESPONSE =~ HTTP_STATUS=([0-9]+) ]]; then
HTTP_STATUS=${BASH_REMATCH[1]}
fi
if [[ $HTTP_STATUS -lt 200 || $HTTP_STATUS -gt 299 ]]; then
echo "HTTP status: $HTTP_STATUS"
else
echo "Done. Parsing ouput..."
echo
echo "${RESPONSE%HTTP_STATUS*}" | jq '.results[].name'
fi
6. Interroger les appareils d’une organisation
Show full configuration example
#!/bin/bash
#--------------------------------------------------------------------------------
# Web service URL, change the server name as needed
SVR_URL="https://<myserver>/api/management/v2/devices/baseInfo/query"
# Access token of an Orga Admin, create it by clicking on the user name in the top right corner of the portal.
# Then click "Profile", "Access tokens", "Add".
ACCESS_TOKEN="<orga_admin_access_token>"
# HTTP Headers
ACCEPT="application/json"
ACCEPT_CHARSET="UTF-8"
# Query example
read -r -d '' JSON_BODY << 'EOF'
{
"limit": 100,
"offset": 0,
"getNonpagedCount": true,
"sortOrder": {
"sortFields": [
{
"name": "lastConnectionDate",
"ascending": false
}
]
},
"filter": {
"type": "logOp",
"operation": "AND",
"filters": [
{
"type": "stringEnum",
"fieldName": "platform",
"values": [
"ANDROID",
"ANDROID_ENTERPRISE",
"IOS"
]
},
{
"type": "stringEnum",
"fieldName": "status",
"values": [
"COMPLIANT"
]
}
]
}
}
EOF
echo "Querying devices at $SVR_URL..."
echo
# No changes should be required beyond this line...
RESPONSE=$(curl -X GET \
${SVR_URL}${FILTER} \
-H "X-User-Access-Token: $ACCESS_TOKEN" \
-H "Accept: $ACCEPT" \
-H "Accept-Charset: $ACCEPT_CHARSET" \
-H "Content-Type: $ACCEPT" \
--write-out " HTTP_STATUS=%{http_code}" \
--silent \
-d "$JSON_BODY")
if [[ $RESPONSE =~ HTTP_STATUS=([0-9]+) ]]; then
HTTP_STATUS=${BASH_REMATCH[1]}
fi
if [[ $HTTP_STATUS -lt 200 || $HTTP_STATUS -gt 299 ]]; then
echo " HTTP status: $HTTP_STATUS"
else
echo "Done. Parsing ouput..."
echo ${RESPONSE%HTTP_STATUS*} | jq '.results[].name'
fi
echo