outlookUser: supportedTimeZones
Namespace: microsoft.graph
Important
APIs under the /beta
version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Get the list of time zones that are supported for the user, as configured on the user's mailbox server.
You can explicitly specify to have time zones returned in the Windows time zone format or Internet Assigned Numbers Authority (IANA) time zone (also known as Olson time zone) format. The Windows format is the default.
When setting up an Outlook client, the user selects the preferred time zone from this supported list. You can subsequently get the preferred time zone by getting the user's mailbox settings.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | User.Read | User.Read.All, User.ReadBasic.All |
Delegated (personal Microsoft account) | User.Read | Not available. |
Application | Not supported. | Not supported. |
HTTP request
GET /me/outlook/supportedTimeZones
GET /users/{id|userPrincipalName}/outlook/supportedTimeZones
GET /me/outlook/supportedTimeZones(TimeZoneStandard=microsoft.graph.timeZoneStandard'{timezone_format}')
GET /users/{id|userPrincipalName}/outlook/supportedTimeZones(TimeZoneStandard=microsoft.graph.timeZoneStandard'{timezone_format}')
Function parameters
Parameter | Type | Description |
---|---|---|
TimeZoneStandard | String | A time zone format. Supported values are: Windows , and Iana . Optional. |
Request headers
Name | Type | Description |
---|---|---|
Authorization | string | Bearer {token}. Required. Learn more about authentication and authorization. |
Request body
Don't supply a request body for this method.
Response
If successful, this method returns 200 OK
response code and a collection of timeZoneInformation objects in the response body.
Example
Request 1
The following example does not specify the timeZoneStandard
parameter, and gets the list of supported time zones represented in the Windows time zone format.
GET https://graph.microsoft.com/beta/me/outlook/supportedTimeZones
Response 1
The following example shows the response.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.timeZoneInformation)",
"value":[
{
"alias":"Dateline Standard Time",
"displayName":"(UTC-12:00) International Date Line West"
},
{
"alias":"Samoa Standard Time",
"displayName":"(UTC+13:00) Samoa"
},
{
"alias":"UTC-11",
"displayName":"(UTC-11:00) Coordinated Universal Time-11"
},
{
"alias":"Aleutian Standard Time",
"displayName":"(UTC-10:00) Aleutian Islands"
}
]
}
Request 2
The following example specifies Iana
for the TimeZoneStandard
parameter, and gets the list of supported time zones represented in IANA format.
GET https://graph.microsoft.com/beta/me/outlook/supportedTimeZones(TimeZoneStandard=microsoft.graph.timeZoneStandard'Iana')
Response 2
The following example shows the response.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.timeZoneInformation)",
"value":[
{
"alias":"Etc/GMT+12",
"displayName":"Etc/GMT+12"
},
{
"alias":"US/Samoa",
"displayName":"US/Samoa"
},
{
"alias":"Etc/GMT+11",
"displayName":"Etc/GMT+11"
},
{
"alias":"US/Aleutian",
"displayName":"US/Aleutian"
}
]
}