servicePrincipal: addPassword
-
[アーティクル]
-
-
名前空間: microsoft.graph
servicePrincipal オブジェクトに強力なパスワードまたはシークレットを追加します。
アクセス許可
この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。
アクセス許可の種類 |
アクセス許可 (特権の小さいものから大きいものへ) |
委任 (職場または学校のアカウント) |
Application.ReadWrite.All |
委任 (個人用 Microsoft アカウント) |
サポートされていません。 |
アプリケーション |
Application.ReadWrite.OwnedBy、Application.ReadWrite.All |
HTTP 要求
POST /servicePrincipals/{id}/addPassword
名前 |
説明 |
Authorization |
ベアラー {token}。必須。 |
Content-Type |
application/json. Required. |
要求本文
要求本文で、空の passwordCredential オブジェクトを指定するか、次の省略可能なプロパティを指定します。
プロパティ |
型 |
説明 |
displayName |
String |
パスワードの分名。 省略可能。 |
endDateTime |
DateTimeOffset |
パスワードの有効期限が切れる日時は、ISO 8601 形式を使用して表され、常に UTC 時刻になります。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 省略可能。 既定値は "startDateTime + 2 年" です。 |
startDateTime |
DateTimeOffset |
パスワードが有効になる日時。 Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 時間です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 省略可能。 既定値は "now" です。 |
応答
成功した場合、このメソッドは応答 200 OK
コードと、応答本文の 新しい passwordCredential オブジェクトを返します。 応答 オブジェクトの secretText プロパティには、16 ~ 64 文字の Azure Active Directoryによって生成される強力なパスワードが含まれています。 将来、このパスワードを取得する方法はありません。
例
次の例は、この API を呼び出す方法を示しています。
要求
要求の例を次に示します。
POST https://graph.microsoft.com/v1.0/servicePrincipals/{id}/addPassword
Content-type: application/json
{
"passwordCredential": {
"displayName": "Password friendly name"
}
}
GraphServiceClient graphClient = new GraphServiceClient( authProvider );
var passwordCredential = new PasswordCredential
{
DisplayName = "Password friendly name"
};
await graphClient.ServicePrincipals["{servicePrincipal-id}"]
.AddPassword(passwordCredential)
.Request()
.PostAsync();
SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
const options = {
authProvider,
};
const client = Client.init(options);
const passwordCredential = {
passwordCredential: {
displayName: 'Password friendly name'
}
};
await client.api('/servicePrincipals/{id}/addPassword')
.post(passwordCredential);
SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];
NSString *MSGraphBaseURL = @"https://graph.microsoft.com/v1.0/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/servicePrincipals/{id}/addPassword"]]];
[urlRequest setHTTPMethod:@"POST"];
[urlRequest setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
NSMutableDictionary *payloadDictionary = [[NSMutableDictionary alloc] init];
MSGraphPasswordCredential *passwordCredential = [[MSGraphPasswordCredential alloc] init];
[passwordCredential setDisplayName:@"Password friendly name"];
payloadDictionary[@"passwordCredential"] = passwordCredential;
NSData *data = [NSJSONSerialization dataWithJSONObject:payloadDictionary options:kNilOptions error:&error];
[urlRequest setHTTPBody:data];
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();
PasswordCredential passwordCredential = new PasswordCredential();
passwordCredential.displayName = "Password friendly name";
graphClient.servicePrincipals("{id}")
.addPassword(ServicePrincipalAddPasswordParameterSet
.newBuilder()
.withPasswordCredential(passwordCredential)
.build())
.buildRequest()
.post();
SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)
requestBody := msgraphsdk.NewPasswordCredentialRequestBody()
passwordCredential := msgraphsdk.NewPasswordCredential()
requestBody.SetPasswordCredential(passwordCredential)
displayName := "Password friendly name"
passwordCredential.SetDisplayName(&displayName)
servicePrincipalId := "servicePrincipal-id"
result, err := graphClient.ServicePrincipalsById(&servicePrincipalId).AddPassword(servicePrincipal-id).Post(requestBody)
SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
Import-Module Microsoft.Graph.Applications
$params = @{
PasswordCredential = @{
DisplayName = "Password friendly name"
}
}
Add-MgServicePrincipalPassword -ServicePrincipalId $servicePrincipalId -BodyParameter $params
SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
応答
応答の例を次に示します。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"customKeyIdentifier": null,
"endDateTime": "2021-09-09T19:50:29.3086381Z",
"keyId": "f0b0b335-1d71-4883-8f98-567911bfdca6",
"startDateTime": "2019-09-09T19:50:29.3086381Z",
"secretText": "[6gyXA5S20@MN+WRXAJ]I-TO7g1:h2P8",
"hint": "[6g",
"displayName": "Password friendly name"
}