servicePrincipal を更新する

[アーティクル]
04/06/2022

名前空間: microsoft.graph

重要

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

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

重要

PATCH を使用して passwordCredential を設定することはサポートされていません。 servicePrincipal のパスワードまたはシークレットを更新するために addPassword および removePassword メソッドを使用します。

アクセス許可

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

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

HTTP 要求

PATCH /servicePrincipals/{id}

要求ヘッダー

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

要求本文

要求本文で、更新する関連フィールドの値を指定します。要求本文に含まれない既存のプロパティは、以前の値のままになるか、他のプロパティ値の変化に基づいて再計算されます。最適なパフォーマンスを得るためには、変更されていない既存の値を含めないでください。

プロパティ	種類	説明
accountEnabled	Boolean	サービスプリンシパルのアカウントが有効な場合は true。それ以外の場合は false。
addIns	addIn	特定のコンテキストで利用者サービスがアプリを呼び出すために使用できるカスタムの動作を定義します。たとえば、ファイルストリームのレダリングが可能なアプリケーションは、そのアプリケーションの "FileHandler" 機能のために addIns プロパティを設定することがあります。これにより、Microsoft 365 などのサービスはユーザーが作業しているドキュメントのコンテキストでアプリケーションを呼び出せるようになります。
alternativeNames	String コレクション	サブスクリプションによってサービスプリンシパルを取得し、管理された ID のリソースグループと完全なリソース ID を識別するために使用されます。
appRoleAssignmentRequired	Boolean	Azure AD がアプリケーションにユーザーまたはアクセストークンを発行する前に、ユーザーまたはグループへの appRoleAssignment が必要であるかどうかを指定します。null不可。
appRoles	appRole コレクション	関連付けられているアプリケーションによって公開されるアプリケーションロール。さらに詳しい情報については、アプリケーションリソースの appRoles プロパティの定義を参照してください。 null 許容ではありません。
customSecurityAttributes	customSecurityAttributeValue	ディレクトリオブジェクトに割り当てられたカスタムセキュリティ属性の値を保持するオープン複合型。このプロパティを更新するには、呼び出し元のプリンシパルに属性割り当て管理者の役割を割り当て、CustomSecAttributeAssignment.ReadWrite.All 権限を付与する必要があります。
displayName	String	サービスプリンシパルの表示名。
HomePage	String	アプリケーションのホームページまたはランディングページ。
keyCredentials	keyCredential コレクション	サービスプリンシパルに関連付けられているキー資格情報のコレクションです。null 許容型ではありません。
loginUrl	String	サービスプロバイダーが認証のためにユーザーを Azure AD にリダイレクトする URL を指定します。 Azure AD は、URL を使用してMicrosoft 365 または Azure AD My Apps からアプリケーションを起動します。空白の場合、Azure AD は SAML ベースのシングルサインオンで構成されたアプリケーションに対して IdP によって開始されるサインオンを実行します。ユーザーは、Microsoft 365、Azure AD My Apps、または Azure AD SSO URL からアプリケーションを起動します。
logoutUrl	String	Microsoft の承認サービスで、フロントチャネル、バックチャネルまたは SAML ログアウトプロトコルを使ってユーザーのログアウトするのに使う URL を指定します。
notificationEmailAddresses	String コレクション	アクティブな証明書が有効期限に近づいたときに Azure AD が通知を送信する電子メールアドレスのリストを指定します。これは、Azure AD Gallery アプリケーション用に発行された SAML トークンに署名するために使用される証明書専用です。
publishedPermissionScopes	permissionScope コレクション	関連するアプリケーションによって公開されている OAuth 2.0 のアクセス許可。さらに詳しい情報については、アプリケーションリソースの oauth2PermissionScopes プロパティの定義を参照してください。 null 許容ではありません。
preferredSingleSignOnMode	string	このアプリケーションに構成されているシングルサインオンモードを指定します。 Azure AD は、優先されるシングルサインオンモードを使用して、Microsoft 365 または Azure AD My Apps からアプリケーションを起動します。サポートされている値は、password、saml、external、および oidc です。
preferredTokenSigningKeyEndDateTime	DateTimeOffset	preferredTokenSigningKeyThumbprint によってマークされたトークンの署名に使用される keyCredential の有効期限を指定します。
preferredTokenSigningKeyThumbprint	String	内部使用専用に予約済みです。このプロパティに書き込みしたり、依存したりしないでください。将来のバージョンで削除される可能性があります。
publisherName	String	関連付けられたアプリケーションが指定されているテナントの表示名。
replyUrls	String コレクション	関連付けられたアプリケーションにサインインするためにユーザートークンが送信される URL、または関連付けられたアプリケーションに対して OAuth 2.0 認証コードとアクセストークンが送信されるリダイレクト URI。null 許容型ではありません。
samlSingleSignOnSettings	samlSingleSignOnSettings	saml シングルサインオンに関連する設定のコレクション。
servicePrincipalNames	String コレクション	関連するアプリケーションからコピーされた identifiersUris のリストが含まれています。ハイブリッドアプリケーションに追加の値を追加できます。これらの値を使用して、Azure AD 内でこのアプリによって公開されるアクセス許可を識別できます。例えば、このリソースへのアクセス許可を要求するクライアントアプリでは、これらの URI を使用して、アプリケーションマニフェストの requiredResourceAccess プロパティや、アプリ登録エクスペリエンスの "API アクセス許可" ブレードで、必要とするアクセス許可を特定することができます。クライアントアプリは、このプロパティの値に基づくリソース URI を指定して、「aud」クレームで返される URI であるアクセストークンを取得できます。複数値プロパティのフィルター式には、任意の演算子が必要です。null 許容ではありません。
tags	String collection	null 許容ではありません。
tokenEncryptionKeyId	String	keyCredentials コレクションにある公開キーの keyId を指定します。構成すると、Azure AD は、このプロパティで指定されたキーを使用して暗号化されたこのアプリケーションのトークンを発行します。暗号化されたトークンを受け取るアプリケーションコードでは、一致する秘密キーを使用してトークンを複合化してから、サインインしているユーザーのトークンとして使用する必要があります。

応答

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

例

例 1: 指定したサービスプリンシパルのプロパティを更新する

要求

以下は、要求の例です。

PATCH https://graph.microsoft.com/beta/servicePrincipals/{id}
Content-type: application/json

{
  "appRoleAssignmentRequired": true
}


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var servicePrincipal = new ServicePrincipal
{
    AppRoleAssignmentRequired = true
};

await graphClient.ServicePrincipals["{servicePrincipal-id}"]
    .Request()
    .UpdateAsync(servicePrincipal);

重要

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

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


const options = {
    authProvider,
};

const client = Client.init(options);

const servicePrincipal = {
  appRoleAssignmentRequired: true
};

await client.api('/servicePrincipals/{id}')
    .version('beta')
    .update(servicePrincipal);

重要

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


MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/beta/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/servicePrincipals/{id}"]]];
[urlRequest setHTTPMethod:@"PATCH"];
[urlRequest setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];

MSGraphServicePrincipal *servicePrincipal = [[MSGraphServicePrincipal alloc] init];
[servicePrincipal setAppRoleAssignmentRequired: true];

NSError *error;
NSData *servicePrincipalData = [servicePrincipal getSerializedDataWithError:&error];
[urlRequest setHTTPBody:servicePrincipalData];

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

        //Request Completed

}];

[meDataTask execute];

重要

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


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

ServicePrincipal servicePrincipal = new ServicePrincipal();
servicePrincipal.appRoleAssignmentRequired = true;

graphClient.servicePrincipals("{id}")
    .buildRequest()
    .patch(servicePrincipal);

重要

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


//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestBody := msgraphsdk.NewServicePrincipal()
appRoleAssignmentRequired := true
requestBody.SetAppRoleAssignmentRequired(&appRoleAssignmentRequired)
servicePrincipalId := "servicePrincipal-id"
graphClient.ServicePrincipalsById(&servicePrincipalId).Patch(requestBody)

重要

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


Import-Module Microsoft.Graph.Applications

$params = @{
    AppRoleAssignmentRequired = $true
}

Update-MgServicePrincipal -ServicePrincipalId $servicePrincipalId -BodyParameter $params

重要

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

応答

以下に応答の例を示します。注: ここに示す応答オブジェクトは、読みやすさのために短縮されている可能性があります。

HTTP/1.1 204 No Content

例 2: 文字列値を持つカスタムセキュリティ属性をサービスプリンシパルに割り当てる

次の例は、文字列値を持つカスタムセキュリティ属性をサービスプリンシパルに割り当てる方法を示しています。

属性セット: Engineering
属性: ProjectDate
属性データ型: 文字列
属性値: "2022-10-01"

カスタムセキュリティ属性を割り当てるには、呼び出し元のプリンシパルに属性割り当て管理者の役割を割り当て、CustomSecAttributeAssignment.ReadWrite.All 権限を付与する必要があります。

ユーザー向けの他の同様の例については、「Microsoft Graph API を使用したカスタムセキュリティ属性の割り当て、更新、または削除」を参照してください。

要求

PATCH https://graph.microsoft.com/beta/servicePrincipals/{id}
Content-type: application/json

{
    "customSecurityAttributes":
    {
        "Engineering":
        {
            "@odata.type":"#Microsoft.DirectoryServices.CustomSecurityAttributeValue",
            "ProjectDate":"2022-10-01"
        }
    }
}


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var servicePrincipal = new ServicePrincipal
{
    CustomSecurityAttributes = new CustomSecurityAttributeValue
    {
        AdditionalData = new Dictionary<string, object>()
        {
            {"Engineering", "{\"@odata.type\":\"#Microsoft.DirectoryServices.CustomSecurityAttributeValue\",\"ProjectDate\":\"2022-10-01\"}"}
        }
    }
};

await graphClient.ServicePrincipals["{servicePrincipal-id}"]
    .Request()
    .UpdateAsync(servicePrincipal);

重要

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


const options = {
    authProvider,
};

const client = Client.init(options);

const servicePrincipal = {
    customSecurityAttributes: 
    {
        Engineering: 
        {
            '@odata.type':'#Microsoft.DirectoryServices.CustomSecurityAttributeValue',
            ProjectDate: '2022-10-01'
        }
    }
};

await client.api('/servicePrincipals/{id}')
    .version('beta')
    .update(servicePrincipal);

重要

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


//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestBody := msgraphsdk.NewServicePrincipal()
customSecurityAttributes := msgraphsdk.NewCustomSecurityAttributeValue()
requestBody.SetCustomSecurityAttributes(customSecurityAttributes)
customSecurityAttributes.SetAdditionalData(map[string]interface{}{
}
servicePrincipalId := "servicePrincipal-id"
graphClient.ServicePrincipalsById(&servicePrincipalId).Patch(requestBody)

重要

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


Import-Module Microsoft.Graph.Applications

$params = @{
    CustomSecurityAttributes = @{
        Engineering = @{
            "@odata.type" = "#Microsoft.DirectoryServices.CustomSecurityAttributeValue"
            ProjectDate = "2022-10-01"
        }
    }
}

Update-MgServicePrincipal -ServicePrincipalId $servicePrincipalId -BodyParameter $params

重要

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

応答

HTTP/1.1 204 No Content

servicePrincipal を更新する

アクセス許可

HTTP 要求

要求ヘッダー

要求本文

応答

例

例 1: 指定したサービス プリンシパルのプロパティを更新する

要求

応答

例 2: 文字列値を持つカスタム セキュリティ属性をサービス プリンシパルに割り当てる

要求

応答

フィードバック

例 1: 指定したサービスプリンシパルのプロパティを更新する

例 2: 文字列値を持つカスタムセキュリティ属性をサービスプリンシパルに割り当てる