Passer au contenu principal
Documentation
Documentation
Adaptive Planning
Dernière mise à jour : 2023-06-23
Ensembles d’autorisations

Ensembles d’autorisations

Point de terminaison de l'adresse URL

https://api.adaptiveplanning.com/api/rest/security/<version>/<tenant>/users/permissionSets
Version : v1
Catégorie
Mise à jour des données
Description
Affectez des ensembles d'autorisations aux utilisateurs Adaptive Planning.
Autorisation requise pour être appelée
Utilisateurs
avec accès administrateur
,
ensembles d'autorisations
L’API Permission Set Assignment vous permet de récupérer et d’affecter des ensembles d’autorisations utilisateur.

HTTPS VERB pris en charge :

Configurer HTTP HTTP
Ressource unique
Ressource de recouvrement
Description
GET
Non pris en charge
Pris en charge
Récupère tous les utilisateurs et les ensembles d’autorisations qui leur ont été affectés.
POST
Pris en charge
Pris en charge
Ajoute un ensemble d’autorisations ou met à jour un ensemble d’autorisations existant pour un utilisateur.

GET

Demande
/users/permissionSets
Récupère un ensemble d'ensembles d'autorisations affectés aux utilisateurs
Récupère tous les utilisateurs et les ensembles d’autorisations qui leur ont été affectés. Vous pouvez filtrer par instanceCode. Si le paramètre d’interrogation instanceCode est manquant, l’API récupère tous les utilisateurs et leurs ensembles d’autorisations dans votre instance par défaut. La pagination utilise les valeurs par défaut pour la limite ou le décalage si vous ne précisez pas ces paramètres d’interrogation.
URI de la demande exemple :
HTTPS://api.adaptiveinsights.com/api/rest/security/v1/default/users/
Paramètres d'interrogation :
Nom
Description
Obligatoire
instanceCode
Identifiant unique d’une instance définissant le contexte de l’instance.
N
limit
Le nombre maximum d’objets dans une seule réponse. La valeur par défaut est de 500. Le maximum est 500.
N
offset
L’index de zéro du premier utilisateur d’une collection de réponses. La valeur par défaut est 0.
Utilisez la valeur de décalage avec le paramètre de limite pour contrôler la pagination d’une collection de réponses.
N
Exemple de réponse
Exemple de réponse d’une instance synchronisée avec Workday
 


  "links": {
      "next": "https://api.adaptiveinsights.com/api/rest/security/v1/default/users/permissionSets?offset=10&limit=5",
      "previous": "https://api.adaptiveinsights.com/api/rest/security/v1/default/users/permissionSets?offset=0&limit=5"
  },{
  "total": 34,
  "users": [
      {
    "userGuid": "111SampleUserGuid",
    "wid": "14400000000000000000000000000samplewid",
    "userName": "sampleuser1@company.com",
    "permissionSet": [
      {
        "id": 1,
        "name": "samplePermissionSet1"
      }
    ]
  },
      {
    "userGuid": "112SampleUserGuid",
    "wid": "24400000000000000000000000000samplewid",
    "userName": "sampleuser3@company.com",
    "permissionSet": [
      {
        "id": 1,
        "name": "samplePermissionSet1"
      }
    ]
  },
      {
    "userGuid": "113SampleUserGuid",
    "wid": "34400000000000000000000000000samplewid",
    "userName": "sampleuser3@company.com",
    "permissionSet": [
      {
        "id": 2,
        "name": "samplePermissionSet2"
      }
    ]
  },
      {
    "userGuid": "114SampleUserGuid",
    "wid": "44400000000000000000000000000samplewid",
    "userName": "sampleuser4@company.com",
    "permissionSet": [
      {
        "id": 3,
        "name": "samplePermissionSet3"
      }
    ]
  },
      {
    "userGuid": "115SampleUserGuid",
    "wid": "54400000000000000000000000000samplewid",
    "userName": "sampleuser5@company.com",
    "permissionSet": [
      {
        "id": 4,
        "name": "samplePermissionSet4"
      }
    ]
  }
]
}

POST :

Demande :
/users/permissionSets:
Affecte ou met à jour des ensembles d’autorisations pour les utilisateurs.
Ajoute un ensemble d’autorisations ou met à jour un ensemble d’autorisations existant pour un utilisateur. Vous pouvez filtrer par instanceCode. Si le paramètre d’interrogation instanceCode est manquant, l’API affecte les ensembles d’autorisations correspondants à tous les utilisateurs de votre instance par défaut. Dans le corps de la demande, précisez les champs d’interrogation obligatoires suivants : <userIdentifier> et permissionSet. Pour soumettre une demande en bloc afin d’affecter des ensembles d’autorisations correspondants à plusieurs utilisateurs, spécifiez un tableau contenant chaque affectation d’autorisation.
Paramètres d'interrogation :
Nom
Description
Obligatoire
instanceCode
Identifiant unique d’une instance définissant le contexte de l’instance.
N
userIdentifier
L'identifiant utilisateur pour déterminer l'identifiant utilisateur Adaptive Planning. Valeurs possibles : userName, wid, userGuid.
Y
Demande d’exemple :
HTTPS://api.adaptiveinsights.com/api/rest/security/v1/default/users/permissionSets?userIdentifier=userName
Corps de la demande d'exemple
Exemple de corps de demande POST
 
[  
  {  
      "userName": "sampleuser1@company.com",
          "permissionSet": [
                  {
                      "name": "samplePermissionSet1"
                  }
      ]
  },
  {
      "userName": "sampleuser2@company.com",
          "permissionSet": [
                  {
                      "name": "samplePermissionSet2"
                  }
          ]
  },
  {
      "userName": "sampleuser3@company.com",
          "permissionSet": [
                  {
                      "name": "samplePermissionSet3"
                  }
          ]
  }
]
Paramètres PayLoad
Nom
Description
Obligatoire
Workday
Identifiant Workday d’un utilisateur.
N
userName
Le nom d’utilisateur (nom de connexion) d’un utilisateur.
N
userGuid
L’identifiant utilisateur unique global, affecté par le système à la création.
N
nom
identifiant
Nom de l’ensemble d’autorisations.
Identifiant de l’ensemble d’autorisations.
Le nom ou l'identifiant de l'ensemble d'autorisations est obligatoire.
Y