Profiles - Get

Référence

Service:: Profile

API Version:: 7.1-preview.3

Obtient un profil utilisateur.

GET https://app.vssps.visualstudio.com/_apis/profile/profiles/{id}?api-version=7.1-preview.3

With optional parameters:

GET https://app.vssps.visualstudio.com/_apis/profile/profiles/{id}?details={details}&withAttributes={withAttributes}&partition={partition}&coreAttributes={coreAttributes}&forceRefresh={forceRefresh}&api-version=7.1-preview.3

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
id	path	True	string	ID du profil utilisateur cible dans le même organization, ou « moi » pour obtenir le profil de l’utilisateur authentifié actuel.
api-version	query	True	string	Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1-preview.3 » pour utiliser cette version de l’API.
coreAttributes	query		string	Liste délimitée par des virgules des attributs de profil principaux à retourner. Les valeurs valides sont Email, Avatar, DisplayName et ContactWithOffers.
details	query		boolean	Retourner des informations de profil public telles que le nom d’affichage, l’adresse e-mail, le pays, etc. Si la valeur est false, le paramètre withAttributes est ignoré.
forceRefresh	query		boolean	Non utilisé dans cette version de l’API.
partition	query		string	Partition (groupe nommé) des attributs à retourner.
withAttributes	query		boolean	Si la valeur est true, obtient les attributs (des paires clé-valeur nommées de données arbitraires) associés au profil. Le paramètre de partition doit également avoir une valeur.

Réponses

Nom	Type	Description
200 OK	Profile	opération réussie

Sécurité

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Nom	Description
vso.profile	Permet de lire votre profil, comptes, collections, projets, équipes et autres artefacts organisationnels de niveau supérieur.

Exemples

Sample Request

HTTP

GET https://app.vssps.visualstudio.com/_apis/profile/profiles/{id}?api-version=7.1-preview.3

Sample Response

Status code:: 200

{
  "displayName": "Normal Paulk",
  "publicAlias": "d6245f20-2af8-44f4-9451-8107cb2767db",
  "emailAddress": "fabrikamfiber16@hotmail.com",
  "coreRevision": 1647,
  "timeStamp": "2014-05-12T22:23:07.727+00:00",
  "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
  "revision": 1647
}

Définitions

Nom	Description
AttributeDescriptor	Identifie un attribut avec un nom et un conteneur.
AttributesContainer	Stocke un ensemble d’attributs de profil nommés.
CoreProfileAttribute	Attribut de profil qui a toujours une valeur pour chaque profil.
Profile	Profil utilisateur.
ProfileAttribute	Objet nommé associé à un profil.
ProfileState	État actuel du profil.

AttributeDescriptor

Identifie un attribut avec un nom et un conteneur.

Nom	Type	Description
attributeName	string	Nom de l'attribut.
containerName	string	Conteneur dans lequel réside l’attribut.

AttributesContainer

Stocke un ensemble d’attributs de profil nommés.

Nom	Type	Description
attributes	<string, ProfileAttribute>	Attributs stockés par le conteneur.
containerName	string	nom du conteneur.
revision	integer	Nombre maximal de révision d’un attribut dans le conteneur.

CoreProfileAttribute

Attribut de profil qui a toujours une valeur pour chaque profil.

Nom	Type	Description
descriptor	AttributeDescriptor	Descripteur de l’attribut.
revision	integer	Numéro de révision de l’attribut.
timeStamp	string	Heure de la dernière modification de l’attribut.
value	string	Valeur de l'attribut.

Profile

Profil utilisateur.

Nom	Type	Description
applicationContainer	AttributesContainer	Attributs de ce profil.
coreAttributes	<string, CoreProfileAttribute>	Attributs principaux de ce profil.
coreRevision	integer	Nombre maximal de révision d’un attribut.
id	string	Identificateur unique du profil.
profileState	ProfileState	État actuel du profil.
revision	integer	Nombre maximal de révision d’un attribut.
timeStamp	string	Heure à laquelle ce profil a été modifié pour la dernière fois.

ProfileAttribute

Objet nommé associé à un profil.

Nom	Type	Description
descriptor	AttributeDescriptor	Descripteur de l’attribut.
revision	integer	Numéro de révision de l’attribut.
timeStamp	string	Heure de la dernière modification de l’attribut.
value	string	Valeur de l'attribut.

ProfileState

État actuel du profil.

Nom	Type	Description
custom	string	Le profil est en cours d’utilisation.
customReadOnly	string	Le profil est en cours d’utilisation, mais ne peut être lu qu’en lecture.
readOnly	string	Le profil peut uniquement être lu.

Share via