GetClientAccessToken 操作
GetClientAccessToken EWS 操作に関する情報を検索します。
GetClientAccessToken 操作は、Outlook 用メール アプリのクライアント アクセス トークンを取得します。
この操作は Exchange Server 2013 で導入されました。
GetClientAccessToken 操作の使用
GetClientAccessToken 操作要求は、アプリの識別子とトークンの種類という 2 つの必須引数を受け取ります。 GetAppManifests 操作を使用して、アプリ識別子を要求できます。
GetClientAccessToken 操作 SOAP ヘッダー
GetClientAccessToken 操作では、次の表に示す SOAP ヘッダーを使用できます。
ヘッダー名 | 要素 | 説明 |
---|---|---|
RequestVersion |
RequestServerVersion |
操作要求のスキーマ バージョンを識別します。 このヘッダーは要求に適用されます。 |
ServerVersion |
ServerVersionInfo |
要求に応答したサーバーのバージョンを識別します。 このヘッダーは、応答に適用できます。 |
GetClientAccessToken 操作要求の例: 呼び出し元 ID トークンを取得する
GetClientAccessToken 操作要求の次の例は、アプリの呼び出し元 ID トークンを取得する方法を示しています。
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages">
<soap:Header>
<t:RequestServerVersion Version="Exchange2013" />
</soap:Header>
<soap:Body >
<m:GetClientAccessToken>
<m:TokenRequests>
<t:TokenRequest>
<t:Id>1C50226D-04B5-4AB2-9FCD-42E236B59E4B</t:Id>
<t:TokenType>CallerIdentity</t:TokenType>
</t:TokenRequest>
</m:TokenRequests>
</m:GetClientAccessToken>
</soap:Body>
</soap:Envelope>
要求 SOAP 本文には、次の要素が含まれています。
GetClientAccessToken 操作の応答が成功しました
次の例は、アプリの呼び出し元 ID トークンを取得するための GetClientAccessToken 操作要求に対する正常な応答を示しています。
注:
この記事のトークン値は、読みやすくするために短縮されています。
<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<h:ServerVersionInfo MajorVersion="15"
MinorVersion="0"
MajorBuildNumber="556"
MinorBuildNumber="14"
Version="Exchange2013"
xmlns:h="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<m:GetClientAccessTokenResponse xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages"
xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types">
<m:ResponseMessages>
<m:GetClientAccessTokenResponseMessage ResponseClass="Success">
<m:ResponseCode>NoError</m:ResponseCode>
<m:Token>
<t:Id>1C50226D-04B5-4AB2-9FCD-42E236B59E4B</t:Id>
<t:TokenType>CallerIdentity</t:TokenType>
<t:TokenValue>eyJ0eXAmv0QitaJg</t:TokenValue>
<t:TTL>479</t:TTL>
</m:Token>
</m:GetClientAccessTokenResponseMessage>
</m:ResponseMessages>
</m:GetClientAccessTokenResponse>
</s:Body>
</s:Envelope>
応答 SOAP 本文には、次の要素が含まれています。
GetClientAccessToken 操作エラー応答
次の例は、 GetClientAccessToken 操作要求に対するエラー応答を示しています。 これは、適切なアクセス許可を持たない拡張機能コールバック トークンを取得するための要求に対する応答です。
<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<h:ServerVersionInfo MajorVersion="15"
MinorVersion="0"
MajorBuildNumber="556"
MinorBuildNumber="14"
Version="Exchange2013"
xmlns:h="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<m:GetClientAccessTokenResponse xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages"
xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types">
<m:ResponseMessages>
<m:GetClientAccessTokenResponseMessage ResponseClass="Error">
<m:MessageText>The caller does not have enough permission for this token request.</m:MessageText>
<m:ResponseCode>ErrorInvalidClientAccessTokenRequest</m:ResponseCode>
<m:DescriptiveLinkKey>0</m:DescriptiveLinkKey>
</m:GetClientAccessTokenResponseMessage>
</m:ResponseMessages>
</m:GetClientAccessTokenResponse>
</s:Body>
</s:Envelope>
エラー応答 SOAP 本文には、次の要素が含まれています。
EWS に汎用であり、この操作に固有のその他のエラー コードについては、「 ResponseCode」を参照してください。