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'URL

https://api.adaptiveplanning.com/api/rest/security/<version>/<tenant>/users/permissionSets
Version : v1
Catégorie
Mise à jour des données
Description
Attribuez des ensembles d'autorisations à des utilisateurs Adaptive Planning.
Autorisation requise pour appeler
Utilisateurs
d'accès administrateur
,
Ensembles d'autorisations
L'API d'affectation d'ensemble d'autorisations vous permet de récupérer et d'affecter des ensembles d'autorisations utilisateur.

VERB HTTPS pris en charge :

Verbe HTTP
Ressource unique
Ressources de recouvrement
Description
GET
Non pris en charge
Prise en charge
Récupère tous les utilisateurs et les ensembles d'autorisations qui leur ont été affectés.
POST
Prise en charge
Prise en charge
Permet d'ajouter ou de mettre à jour un ensemble d'autorisations existant pour un utilisateur.

GET

Demander
/users/permissionSets
Récupère un ensemble d'ensembles d'autorisations attribué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 de requête 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 spécifiez pas ces paramètres de requête.
Exemple d'URI de demande :
HTTPS://api.adaptiveinsights.com/api/rest/security/v1/default/users/
Paramètres de la requête :
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 même réponse. La valeur par défaut est 500. Le maximum est 500.
N
offset
Index à base zéro du premier utilisateur dans une collection de réponse. La valeur par défaut est 0.
Utilisez le décalage avec le paramètre de limite pour contrôler la pagination d'un ensemble de réponses.
N
Exemple de réponse
Exemple de réponse d'une instance synchronisée avec l'utilisateur 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:
Attribue ou met à jour des ensembles d'autorisations pour des utilisateurs.
Permet d'ajouter ou de mettre à jour un ensemble d'autorisations existant pour un utilisateur. Vous pouvez filtrer par instanceCode. Si le paramètre de requête 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, indiquez les champs de requête obligatoires suivants : <userIdentifier> et permissionSet. Pour soumettre une demande en bloc afin d'attribuer les ensembles d'autorisations correspondants à plusieurs utilisateurs, spécifiez un tableau contenant chaque affectation d'autorisation.
Paramètres de la requête :
Nom
Description
Obligatoire
instanceCode
Identifiant unique d'une instance définissant le contexte de l'instance.
N
userIdentifier
L'identifiant utilisateur pour déterminer le code utilisateur Adaptive Planning unique. Valeurs possibles : userName, wid, userGuid.
O
Exemple de demande :
HTTPS://api.adaptiveinsights.com/api/rest/security/v1/default/users/permissionSets?userIdentifier=userName
Exemple de corps de demande
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 de PayLoad
Nom
Description
Obligatoire
identifiant Workday
L'identifiant Workday d'un utilisateur.
N
nom d'utilisateur
Le nom d'utilisateur (nom de connexion) d'un utilisateur.
N
userGuid
Identifiant utilisateur unique global, affecté par le système à la création.
N
nom
id
Nom de l'ensemble d'autorisations.
Identifiant de l'ensemble d'autorisations.
Le nom ou l'identifiant de l'ensemble d'autorisations est obligatoire.
O