Export (0) Print
Expand All

Contact

Updated: August 15, 2013

Applies To: Windows Azure AD Graph.

Overview

This topic provides descriptions of the properties of the Contact entity.

Windows Azure AD Graph exposes metadata that describes the directory as an Entity Data Model (EDM) using Conceptual Schema Definition Language (CSDL). You can view the metadata exposed for your tenant by performing an HTTP GET from the following URL: https://graph.windows.net/yourTenantDomain/$metadata?api-version=2013-04-05. Replace yourTenantDomain with the domain of your tenant; for example, https://graph.windows.net/contoso.onmicrosoft.com/$metadata?api-version=2013-04-05. For more information about the EDM and CSDL, see Entity Data Model.

Properties

The Contact entity is defined as follows:

Namespace: Microsoft.WindowsAzure.ActiveDirectory

Base type: DirectoryObject

 

Name Type Notes Read/Write Key Filterable Description

city

Edm.String

RW

Yes

The city in which the contact is located.

country

Edm.String

RW

Yes

The country/region in which the contact is located.

department

Edm.String

RW

Yes

The name for the department in which the contact works.

dirSyncEnabled

Edm.Boolean

R

Yes

Indicates whether this object was synced from the on-premises directory.

displayName

Edm.String

RW

Yes

The display name for the contact.

facsimileTelephoneNumber

Edm.String

RW

The telephone number of the contact’s business fax machine.

givenName

Edm.String

RW

Yes

The given name (first name) of the contact.

jobTitle

Edm.String

RW

Yes

The contact’s job title.

lastDirSyncTime

Edm.DateTime

R

Yes

Indicates the last time at which the object was synced with the on-premises directory.

Mail

Edm.String

RW

Yes

The SMTP address for the contact, for example, "jeff@contoso.onmicrosoft.com".

mailNickName

Edm.String

RW

The mail alias for the contact.

mobile

Edm.String

RW

The primary cellular telephone number for the contact.

objectId

Edm.String

Immutable, not nullable, unique.

R

Yes

Yes

The unique identifier for the contact. Inherited from DirectoryObject.

objectType

Edm.String

R

A string that identifies the object type. For contacts the value is always “Contact”. Inherited from DirectoryObject.

physicalDeliveryOfficeName

Edm.String

RW

The office location in the contact's place of business.

postalCode

Edm.String

RW

The postal code for the contact's postal address. The postal code is specific to the contact's country/region. In the United States of America, this attribute contains the ZIP code.

provisioningErrors

Collection(ProvisioningError)

Not nullable

R

A collection of error details that are preventing this contact from being provisioned successfully.

proxyAddresses

Collection(Edm.String)

Unique, not nullable

R

state

Edm.String

RW

Yes

The state or province in the contact's address.

streetAddress

Edm.String

RW

The street address of the contact's place of business.

surname

Edm.String

RW

Yes

The contact's surname (family name or last name).

telephoneNumber

Edm.String

RW

The primary telephone number of the contact's place of business.

thumbnailPhoto

Edm.Stream

Not nullable

RW

A thumbnail photo to be displayed for the contact.

For information about the primitive types exposed by the EDM, see Entity Data Model: Primitive Data Types.

Navigation Properties

Name From From Multiplicity To To Multiplicity Description

manager

Contact

*

DirectoryObject

(Only User and Contact objects are supported.)

0..1

The user or contact that is this contact’s manager. Inherited from DirectoryObject.

HTTP Methods: GET, PUT, DELETE

directReports

Contact

*

DirectoryObject

(Only User and Contact objects are supported.)

*

The contact’s direct reports. (The users and contacts that have their manager property set to this contact.) Inherited from DirectoryObject.

HTTP Methods: GET

memberOf

Contact

*

DirectoryObject

(Only Group objects are supported.)

*

Groups that this contact is a member of. Inherited from DirectoryObject.

HTTP Methods: GET

noteNote
Contact also inherits the members navigation property from DirectoryObject; however, this property is not valid for contacts. If a request for this property is sent, a 400 Bad Request response is returned.

Addressing

The following list shows how to address the contacts resource set, which spans all the roles in the directory; an individual contact; and the navigation properties of a contact. The examples in the list use the tenant domain to address the tenant. For other ways of addressing the tenant, see Addressing Entities and Operations in the Graph.

  • Resource Set: https://graph.windows.net/<tenantDomain>/contacts?api-version=<version>. For example, https://graph.windows.net/contoso.onmicrosoft.com/contacts?api-version=2013-04-05.

  • Contact: https://graph.windows.net/<tenantDomain>/contacts/<objectId>?api-version=<version>. For example, https://graph.windows.net/contoso.onmicrosoft.com/contacts/12345678-9abc-def0-1234-56789abcde?api-version=2013-04-05.

  • Navigation Property: https://graph.windows.net/<tenantDomain>/contacts/<objectId>/$links/<property name>?api-version=<version>. For example, https://graph.windows.net/contoso.onmicrosoft.com/contacts/12345678-9abc-def0-1234-56789abcde/$links/memberOf?api-version=2013-04-05.

noteNote
Remove the “$links” segment of the navigation property URI to return the objects referenced by a navigation property rather than links to them. This mode of addressing can be used for read operations only. Contacts or their navigation properties can also be addressed as generic directory objects by replacing “contacts” with “directoryObjects” in the URI.

For more comprehensive information about querying directory objects, see Windows Azure AD Graph Common Queries and Windows Azure AD Graph Differential Query.

Supported Operations and Permissions

The following operations are supported on contacts (the HTTP method used for each is in parentheses): Read (GET) and Delete (DELETE). The following operations are supported on contact navigation properties: Read (GET), Update (PUT), and Delete (DELETE); not all operations are supported on every navigation property.

The service principal that represents an application must be in an administrator role that has permissions to modify contact objects to send PUT or DELETE requests. It must be in a role that has permissions to read contact objects to send GET requests. For more information about roles in Windows Azure AD Graph, see Windows Azure AD Graph and Role-Based Access Control.

Remarks

Contacts are mail-enabled entities and cannot be created by using Windows Azure AD Graph.

For more information operations on contacts including examples, see Operations on Contacts.

See Also

Show:
© 2014 Microsoft