Répertorier orgContacts
Espace de noms: microsoft.graph
Obtenez la liste des contacts de l’organisation pour cette organization.
Cette API est disponible dans les déploiements de cloud national suivants.
Service global | Gouvernement des États-Unis L4 | Us Government L5 (DOD) | Chine gérée par 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Autorisations
Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.
Type d’autorisation | Autorisations avec privilèges minimum | Autorisations privilégiées plus élevées |
---|---|---|
Déléguée (compte professionnel ou scolaire) | OrgContact.Read.All | Directory.Read.All, Directory.ReadWrite.All |
Déléguée (compte Microsoft personnel) | Non prise en charge. | Non prise en charge. |
Application | OrgContact.Read.All | Directory.Read.All, Directory.ReadWrite.All |
Requête HTTP
GET /contacts
Paramètres facultatifs de la requête
Cette méthode prend en charge les $count
paramètres de requête , $orderby
$filter
$expand
, $search
, , $select
, et$top
OData pour personnaliser la réponse. Certaines requêtes sont prises en charge uniquement lorsque vous utilisez l’en-tête ConsistencyLevel défini sur eventual
et $count
. Pour plus d’informations, consultez Fonctionnalités de requête avancées sur les objets d’annuaire.
En-têtes de demande
En-tête | Valeur |
---|---|
Autorisation | Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation. |
ConsistencyLevel | éventuellement. Cet en-tête et cet $count sont requis lors de l’utilisation de $search , ou dans une utilisation spécifique de $filter . Pour plus d’informations sur l’utilisation de ConsistencyLevel et $count , consultez Fonctionnalités de requête avancées sur les objets d’annuaire. |
Corps de la demande
N’indiquez pas le corps de la demande pour cette méthode.
Réponse
Si elle réussit, cette méthode renvoie un 200 OK
code de réponse et une collection d’objets orgContact dans le corps de la réponse.
Exemples
Exemple 1 : Obtenir des contacts organisationnels pour une organization
Demande
L’exemple suivant illustre une demande.
GET https://graph.microsoft.com/v1.0/contacts
Réponse
L’exemple suivant illustre la réponse.
Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"companyName": "Contoso",
"department": "Marketing",
"displayName": "Eric S",
"givenName":"Eric",
"jobTitle":"Accountant",
"mail":"erics@contoso.com",
"mailNickname":"erics",
"surname":"Solomon",
"addresses":[
{
"city":"MyCity",
"countryOrRegion":"United States",
"officeLocation":"MyCity",
"postalCode":"98000",
"state":"WA",
"street":"Contoso Way"
}
],
"phones":[
{
"number":"111-1111",
"type":"businessFax"
}
]
}
]
}
Exemple 2 : Obtenir uniquement le nombre de contacts de l’organisation
Demande
L’exemple suivant illustre une demande. Cette demande nécessite que l’en-tête ConsistencyLevel soit défini sur eventual
, car $count
figure dans la demande. Pour plus d’informations sur l’utilisation de ConsistencyLevel et $count
, consultez Fonctionnalités de requête avancées sur les objets d’annuaire.
Remarque : Les paramètres de requête
$count
et$search
ne sont actuellement pas disponibles dans les clients Azure AD B2C.
GET https://graph.microsoft.com/v1.0/contacts/$count
ConsistencyLevel: eventual
Réponse
L’exemple suivant illustre la réponse.
HTTP/1.1 200 OK
Content-type: text/plain
893
Exemple 3 : Utiliser $filter et $top pour obtenir un contact organisationnel avec un nom d’affichage commençant par « a », y compris le nombre d’objets retournés
Demande
L’exemple suivant illustre une demande. Cette requête nécessite que l’en-tête ConsistencyLevel soit défini sur eventual
et la chaîne de requête $count=true
, car la requête a les paramètres de requête $orderby
et $filter
. Pour plus d’informations sur l’utilisation de ConsistencyLevel et $count
, consultez Fonctionnalités de requête avancées sur les objets d’annuaire.
Remarque : Les paramètres de requête
$count
et$search
ne sont actuellement pas disponibles dans les clients Azure AD B2C.
GET https://graph.microsoft.com/v1.0/contacts?$filter=startswith(displayName,'A')&$count=true&$top=1&$orderby=displayName
ConsistencyLevel: eventual
Réponse
L’exemple suivant illustre la réponse.
Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/v1.0/$metadata#contacts",
"@odata.count":1,
"value":[
{
"displayName":"Abigail Jackson",
"mail":"abigailJ@contoso.com",
"mailNickname":"abigailJ"
}
]
}
Exemple 4 : Utiliser $search pour obtenir des contacts organisationnels avec des noms d’affichage qui contiennent les lettres « wa », y compris le nombre d’objets retournés
Demande
L’exemple suivant illustre une demande. Cette demande exige la configuration de l’entête ConsistencyLevel sur eventual
sachant que $search
et la $count=true
chaîne se requête se trouvent dans la chaîne de requête. Pour plus d’informations sur l’utilisation de ConsistencyLevel et $count
, consultez Fonctionnalités de requête avancées sur les objets d’annuaire.
Remarque : Les paramètres de requête
$count
et$search
ne sont actuellement pas disponibles dans les clients Azure AD B2C.
GET https://graph.microsoft.com/v1.0/contacts?$search="displayName:wa"&$count=true
ConsistencyLevel: eventual
Réponse
L’exemple suivant illustre la réponse.
Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/v1.0/$metadata#contacts",
"@odata.count":22,
"value":[
{
"displayName":"Nicole Wagner",
"mail":"nicolewa@contoso.com",
"mailNickname":"nicolewa"
}
]
}
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour