samlOrWsFedExternalDomainFederation を更新する

名前空間: microsoft.graph

重要

Microsoft Graph のバージョンの /beta API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。

samlOrWsFedExternalDomainFederation オブジェクトのプロパティを更新します。

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アクセス許可の種類	アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント)	IdentityProvider.ReadWrite.All
委任 (個人用 Microsoft アカウント)	サポートされていません。
アプリケーション	IdentityProvider.ReadWrite.All

職場または学校アカウントは、次のいずれかの Azure Active Directory (Azure AD) ロールに属している必要があります。

• グローバル管理者
• 外部 ID プロバイダー管理者

HTTP 要求

PATCH directory/federationConfigurations/graph.samlOrWsFedExternalDomainFederation/{samlOrWsFedExternalDomainFederation ID}

要求ヘッダー

名前	説明
Authorization	ベアラー {token}。必須。
Content-Type	application/json. Required.

要求本文

要求本文で、Azure AD テナントの samlOrWsFedExternalDomainFederation オブジェクトに対して更新する必要がある 1 つ以上のプロパティを含む JSON オブジェクトを指定します。

次の表は、 samlOrWsFedExternalDomainFederation オブジェクトに 対して更新できるプロパティを示しています。

プロパティ	型	説明
displayName	String	SAML/WS-Fed ベースの ID プロバイダーの表示名。 identityProviderBase から継承されます。
issuerUri	String	フェデレーション サーバーの発行者 URI。 samlOrWsFedProvider から継承されます。
metadataExchangeUri	文字列	リッチ クライアント アプリケーションからの認証に使用されるメタデータ交換エンドポイントの URI。 samlOrWsFedProvider から継承されます。
passiveSignInUri	文字列	Azure AD サービスにサインインするときに Web ベースのクライアントが送信する URI。 samlOrWsFedProvider から継承されます。
preferredAuthenticationProtocol	String	優先認証プロトコル。 サポートされている値には、次のものが含まれますsaml。.wsfed samlOrWsFedProvider から継承されます。
signingCertificate	String	Microsoft ID プラットフォームに渡されたトークンに署名するために使用される現在の証明書。 証明書は、フェデレーション IdP のトークン署名証明書のパブリック部分の Base64 でエンコードされた文字列として書式設定され、X509Certificate2 クラスと互換性がある必要があります。 このプロパティは、次のシナリオで使用されます。 自動ロールオーバー更新の外部でロールオーバーが必要な場合 新しいフェデレーション サービスが設定されている フェデレーション サービス証明書が更新された後、新しいトークン署名証明書がフェデレーション プロパティに存在しない場合。 Azure AD は、現在の証明書の有効期限の 30 日前にフェデレーション サービス メタデータから新しい証明書を取得しようとする自動登録プロセスを使用して証明書を更新します。 新しい証明書を使用できない場合、Azure AD はメタデータを毎日監視し、新しい証明書が使用可能になるとドメインのフェデレーション設定を更新します。

応答

成功した場合、このメソッドは応答コードと、応答本文で更新された samlOrWsFedExternalDomainFederation オブジェクトを返200 OKします。

例

要求

HTTP

PATCH https://graph.microsoft.com/beta/directory/federationConfigurations/graph.samlOrWsFedExternalDomainFederation/d5a56845-6845-d5a5-4568-a5d54568a5d5
Content-Type: application/json

{
  "displayName": "Contoso name change",
  "issuerUri": "http://contoso-test.com/adfs/services/trust",
  "metadataExchangeUri": null,
  "signingCertificate": "M66C6DCCAdCgAwIBAgIQQ6vYJIVKQ",
  "passiveSignInUri": "https://contoso-test.com/adfs/ls/",
  "preferredAuthenticationProtocol": "wsFed"
}

C#

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var samlOrWsFedExternalDomainFederation = new SamlOrWsFedExternalDomainFederation
{
    DisplayName = "Contoso name change",
    IssuerUri = "http://contoso-test.com/adfs/services/trust",
    MetadataExchangeUri = null,
    SigningCertificate = "M66C6DCCAdCgAwIBAgIQQ6vYJIVKQ",
    PassiveSignInUri = "https://contoso-test.com/adfs/ls/",
    PreferredAuthenticationProtocol = AuthenticationProtocol.WsFed
};

await graphClient.Directory.FederationConfigurations["{samlOrWsFedExternalDomainFederation-id}"]
    .Request()
    .UpdateAsync(samlOrWsFedExternalDomainFederation);

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ 版で使用できるすべての種類、プロパティ、API はサポートされていません。 SDK を使用してベータ API にアクセスする方法の詳細については、「Microsoft Graph SDK とベータ API を使用する」を参照してください。

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

JavaScript

const options = {
    authProvider,
};

const client = Client.init(options);

const samlOrWsFedExternalDomainFederation = {
  displayName: 'Contoso name change',
  issuerUri: 'http://contoso-test.com/adfs/services/trust',
  metadataExchangeUri: null,
  signingCertificate: 'M66C6DCCAdCgAwIBAgIQQ6vYJIVKQ',
  passiveSignInUri: 'https://contoso-test.com/adfs/ls/',
  preferredAuthenticationProtocol: 'wsFed'
};

await client.api('/directory/federationConfigurations/graph.samlOrWsFedExternalDomainFederation/d5a56845-6845-d5a5-4568-a5d54568a5d5')
    .version('beta')
    .update(samlOrWsFedExternalDomainFederation);

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ 版で使用できるすべての種類、プロパティ、API はサポートされていません。 SDK を使用してベータ API にアクセスする方法の詳細については、「Microsoft Graph SDK とベータ API を使用する」を参照してください。

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

Objective-C

MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/beta/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/directory/federationConfigurations/graph.samlOrWsFedExternalDomainFederation/d5a56845-6845-d5a5-4568-a5d54568a5d5"]]];
[urlRequest setHTTPMethod:@"PATCH"];
[urlRequest setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];

MSGraphSamlOrWsFedExternalDomainFederation *samlOrWsFedExternalDomainFederation = [[MSGraphSamlOrWsFedExternalDomainFederation alloc] init];
[samlOrWsFedExternalDomainFederation setDisplayName:@"Contoso name change"];
[samlOrWsFedExternalDomainFederation setIssuerUri:@"http://contoso-test.com/adfs/services/trust"];
[samlOrWsFedExternalDomainFederation setMetadataExchangeUri: null];
[samlOrWsFedExternalDomainFederation setSigningCertificate:@"M66C6DCCAdCgAwIBAgIQQ6vYJIVKQ"];
[samlOrWsFedExternalDomainFederation setPassiveSignInUri:@"https://contoso-test.com/adfs/ls/"];
[samlOrWsFedExternalDomainFederation setPreferredAuthenticationProtocol: [MSGraphAuthenticationProtocol wsFed]];

NSError *error;
NSData *samlOrWsFedExternalDomainFederationData = [samlOrWsFedExternalDomainFederation getSerializedDataWithError:&error];
[urlRequest setHTTPBody:samlOrWsFedExternalDomainFederationData];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        //Request Completed

}];

[meDataTask execute];

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ 版で使用できるすべての種類、プロパティ、API はサポートされていません。 SDK を使用してベータ API にアクセスする方法の詳細については、「Microsoft Graph SDK とベータ API を使用する」を参照してください。

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

SamlOrWsFedExternalDomainFederation samlOrWsFedExternalDomainFederation = new SamlOrWsFedExternalDomainFederation();
samlOrWsFedExternalDomainFederation.displayName = "Contoso name change";
samlOrWsFedExternalDomainFederation.issuerUri = "http://contoso-test.com/adfs/services/trust";
samlOrWsFedExternalDomainFederation.metadataExchangeUri = null;
samlOrWsFedExternalDomainFederation.signingCertificate = "M66C6DCCAdCgAwIBAgIQQ6vYJIVKQ";
samlOrWsFedExternalDomainFederation.passiveSignInUri = "https://contoso-test.com/adfs/ls/";
samlOrWsFedExternalDomainFederation.preferredAuthenticationProtocol = AuthenticationProtocol.WS_FED;

graphClient.directory().federationConfigurations().graph.samlOrWsFedExternalDomainFederation("d5a56845-6845-d5a5-4568-a5d54568a5d5")
    .buildRequest()
    .patch(samlOrWsFedExternalDomainFederation);

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ 版で使用できるすべての種類、プロパティ、API はサポートされていません。 SDK を使用してベータ API にアクセスする方法の詳細については、「Microsoft Graph SDK とベータ API を使用する」を参照してください。

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

応答の例を次に示します。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 200 OK
Content-Type: application/json

{
 "id": "d5a56845-6845-d5a5-4568-a5d54568a5d5",
  "displayName": "Contoso name change",
  "issuerUri": "http://contoso-test.com/adfs/services/trust",
  "metadataExchangeUri": null,
  "signingCertificate": "M66C6DCCAdCgAwIBAgIQQ6vYJIVKQ",
  "passiveSignInUri": "https://contoso-test.com/adfs/ls/",
  "preferredAuthenticationProtocol": "wsFed",
  "domains": [
      {
          "id": "contoso.com"
      }
  ]
}