Opérations de l'interface

Affichez toutes les opérations du service REST distant pour PUMA, y compris les attributs requis et une description.

La liste suivante présente et décrit toutes les opérations de chemin d'URI possibles, avec les paramètres de requête requis. Notez que certaines de ces opérations s'appliquent à des méthodes HTTP différentes - GET, ou PUT et POST, ou DELETE.

Notational convention : Les valeurs de paramètres sont séparées par des barres verticales ( | ). Les valeurs par défaut sont signalées par un caractère astérisque (*).

/um/attributes/users

For the HTTP method GET:

Cette opération de chemin d'URI renvoie la liste des références aux définitions d'attribut qui sont disponibles pour les utilisateurs conjointement avec l'opération de chemin d'URI /um/attributes/users/attribute name. Cette opération comporte le paramètre de requête suivant :

expandRefs=true | *false: Si vous définissez ce paramètre sur true, les représentations des définitions d'attribut sont intégrées dans la liste des références. La valeur par défaut est false.

/um/attributes/users/attribute name

For the HTTP method GET:: Cette opération de chemin d'URI renvoie une représentation de la définition de l'attribut. Pour plus d'informations, reportez-vous à la rubrique dédiée à la description de la charge. Cette opération de chemin d'URI ne comporte pas de paramètre de requête.

/um/attributes/groups

For the HTTP method GET:

Cette opération de chemin d'URI renvoie la liste des références aux définitions d'attribut qui sont disponibles pour les groupes conjointement avec l'opération de chemin d'URI /um/attributes/groups/attribute name. Cette opération comporte le paramètre de requête suivant :

expandRefs=true|*false: If you set this parameter to true, the representations of the attribute definitions are embedded in the list of references. La valeur par défaut est false.

/um/attributes/groups/attribute name

For the HTTP method GET:: Cette opération de chemin d'URI renvoie une représentation de la définition de l'attribut. Pour plus d'informations, reportez-vous à la rubrique dédiée à la description de la charge. Cette opération de chemin d'URI ne comporte pas de paramètre de requête.

/um/currentuser/profile

For the HTTP method GET:: Cette opération de chemin d'URI renvoie le profil de l'utilisateur actuel. Si cette opération est effectuée sans authentification, le profil renvoyé est celui de l'utilisateur anonyme. Cette opération de chemin d'URI ne comporte pas de paramètre de requête.

For the HTTP methods PUT or POST:

Cette opération de chemin d'URI actualise le profil d'utilisateur à partir de la représentation de profil contenue dans le corps de la requête. Seuls les attributs fournis dans cette représentation sont pris en compte. Par conséquent, n'utilisez la commande post que pour les attributs que vous désirez modifier. Cette opération de chemin d'URI comporte les paramètres de requête suivants :

update=*replace|merge|delete

Définit comment effectuer la mise à jour. Les valeurs admises sont les suivantes :

replace: Toutes les valeurs d'attribut indiquées dans la mise à jour remplacent celles existantes. Il s'agit de la valeur par défaut.
merge: Les nouvelles valeurs d'attribut sont fusionnées avec les valeurs existantes. Ce paramètre n'est pertinent que dans le cas d'attributs avec valeurs multiples.
supprimer: Les valeurs de tous les attributs indiqués dans la mise à jour sont supprimées du profil. Par conséquent, les valeurs d'attribut effectives fournies dans la mise à jour sont ignorées.

/um/users/profiles /um/groups/profiles

For the HTTP method GET:

Cette opération de chemin d'URI renvoie la liste des références de tous les utilisateurs ou groupes correspondant aux critères de la recherche et aux autres paramètres. En l'absence de paramètre limitatif, tous les utilisateurs et les groupes disponibles sont renvoyés. La liste retournée est filtrée par le contrôle d'accès en fonction de l'utilisateur actuel. Cette opération de chemin d'URI comporte les paramètres de requête suivants :

expandRefs=true|*false: Si vous définissez ce paramètre sur true, les profils complets sont intégrés dans les références. La valeur par défaut est false.
includeAttributes: Les attributs contenus dans les profils sont circonscrits à ceux, séparés par une virgule, spécifiés dans la liste fournie par cet attribut. Par défaut, si vous omettez ce paramètre, la liste de base des attributs est renvoyée pour les utilisateurs, et pour les groupes, le jeu d'attributs minimal.
memberOf=unique ID of group: La réponse contient uniquement les profils des utilisateurs ou des groupes membres du groupe spécifié.
showNested=true|*false: Si le paramètre memberOf est défini, il détermine si les groupes imbriqués sont pris en compte ou non. S'il est défini sur false, seule l'appartenance directe à un groupe est évaluée. La valeur par défaut est false.
searchAttributes: Ce paramètre permet de définir une chaîne de recherche spécifiant diverses combinaisons de valeurs d'attribut en tant que critère de recherche. Toutes les implémentations doivent prendre en charge au minimum des valeurs telles que attribute name%3Dattribute value, dans lesquelles la valeur d'attribut peut contenir un astérisque (*) comme caractère générique.
identificateur: La liste renvoyée comprend uniquement l'utilisateur ou le groupe avec l'identificateur unique spécifié. L'implémentation détermine l'élément à utiliser comme identificateur unique. Il peut s'agir, par exemple, du nom distinctif.
resultsPerPage: La liste renvoyée contient uniquement le nombre donné de résultats. De plus, des liens vers les pages de résultats supplémentaires (première, dernière, suivante, précédente) seront compris dans la réponse, si disponible.
sortByAttributes: Liste séparée par des virgules indiquant l'ordre de tri des résultats. Ceci est uniquement pris en charge pour une recherche paginée.
descending=true|*false: Détermine si le tri en fonction de sortByAttributes sera par ordre décroissant.

Remarque : Les paramètres memberOf, searchAttributes et identifier s'excluent mutuellement. La recherche paginée (resultsPerPage) fonctionne uniquement pour l'élément searchAttributes.

For the HTTP method POST:: Cette opération de chemin d'URI crée un nouvel utilisateur ou un nouveau groupe en publiant une représentation du profil associé. Pour plus d'informations, reportez-vous à la rubrique dédiée à la description de la charge. Cette opération de chemin d'URI ne comporte pas de paramètre de requête.

/um/users/profiles/unique ID of user /um/groups/profiles/unique ID of group

For the HTTP method GET:

Cette opération de chemin d'URI renvoie une représentation du profil de l'utilisateur ou du groupe. Pour plus d'informations, reportez-vous à la rubrique dédiée à la description de la charge. Cette opération comporte le paramètre de requête suivant :

includeAttributes: Les attributs contenus dans les profils sont circonscrits à ceux, séparés par une virgule, spécifiés dans la liste fournie par cet attribut. Par défaut, si vous omettez ce paramètre, tous les attributs contenant des valeurs sont renvoyés.

For the HTTP methods PUT or POST:

Cette opération de chemin d'URI actualise le profil de l'utilisateur ou du groupe à partir de la représentation de profil contenue dans le corps de la requête. Seuls les attributs fournis dans cette représentation sont pris en compte. Par conséquent, n'utilisez la commande post que pour les attributs que vous désirez modifier. Cette opération de chemin d'URI comporte les paramètres de requête suivants :

update=*replace|merge|delete

Définit comment effectuer la mise à jour. Les valeurs admises sont les suivantes :

replace: Toutes les valeurs d'attribut indiquées dans la mise à jour remplacent celles existantes. Il s'agit de la valeur par défaut.
merge: Les nouvelles valeurs d'attribut sont fusionnées avec les valeurs existantes. Ce paramètre n'est pertinent que dans le cas d'attributs avec valeurs multiples.
supprimer: Les valeurs de tous les attributs indiqués dans la mise à jour sont supprimées du profil. Par conséquent, les valeurs d'attribut effectives fournies dans la mise à jour sont ignorées.

For the HTTP method DELETE:: Cette opération de chemin d'URI supprime l'utilisateur ou le groupe. Cette opération de chemin d'URI ne comporte pas de paramètre de requête.

/um/groupmembership/unique ID of user /um/groupmembership/unique ID of group

For the HTTP method GET:

Cette opération de chemin d'URI renvoie la liste des références de tous les profils de groupe dont est membre l'utilisateur ou le groupe. Voir les opérations de chemin d'URI /um/users/profiles/unique ID of user et /um/group/profiles/unique ID of group répertoriées précédemment. Cette opération est également dénommée Liste d'appartenance. Pour plus d'informations, reportez-vous à la rubrique dédiée à la description de la charge. Cette opération de chemin d'URI comporte les paramètres de requête suivants :

expandRefs=true|*false: Si vous définissez ce paramètre sur true, les profils complets sont intégrés dans les références. La valeur par défaut est false.
includeAttributes: Les attributs contenus dans les profils sont circonscrits à ceux, séparés par une virgule, spécifiés dans la liste fournie par cet attribut. Par défaut, si vous omettez ce paramètre, la liste de base des attributs est renvoyée pour les utilisateurs, et pour les groupes, le jeu d'attributs minimal.
showNested=true|*false: Ce paramètre spécifie si les groupes imbriqués sont pris en compte ou non. If you set the parameter to false, only direct membership is evaluated. La valeur par défaut est false.

For the HTTP methods PUT or POST:

Cette opération de chemin d'URI actualise la liste d'appartenance actuelle de l'utilisateur ou du groupe avec celle publiée. Cette opération de chemin d'URI comporte les paramètres de requête suivants :

update=*replace|merge|delete

Définit comment effectuer la mise à jour. Les valeurs possibles sont les suivantes :

replace: La liste d'appartenance complète est remplacée par celle publiée. Il s'agit de la valeur par défaut.
merge: L'utilisateur ou le groupe contenus dans la liste d'appartenance publiée sont ajoutés aux relations existantes d'appartenance à des groupes de l'utilisateur ou du groupe.
supprimer: L'utilisateur ou le groupe sont supprimés uniquement de tous les groupes contenus dans la liste publiée.

For the HTTP method DELETE:: Cette opération de chemin d'URI supprime la liste d'appartenance de l'utilisateur ou du groupe ; ceci entraîne que l'utilisateur ou le groupe sont supprimés de tous les groupes. Cette opération de chemin d'URI ne comporte pas de paramètre de requête.