privilegedRoleAssignmentRequest を作成する

名前空間: microsoft.graph

重要

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

注意事項

Azure Active Directory (Azure AD) ロール用のこのバージョンのPrivileged Identity Management (PIM) API は非推奨となり、2021 年 5 月 31 日にデータの返しが停止されました。 新しい ロール管理 API を使用します。

privilegedroleassignmentrequest オブジェクトを作成します。

アクセス許可

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

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

HTTP 要求

POST /privilegedRoleAssignmentRequests

要求ヘッダー

名前	説明
Authorization	ベアラー {token}。必須。

要求本文

要求本文で、 privilegedroleassignmentrequest オブジェクトの JSON 表現を指定します。

プロパティ	種類	説明
roleId	String	ロールの ID。 必須。
type	String	ロールの割り当てに対する操作の種類を表します。 値は AdminAdd次のとおりです。管理者はロールにユーザーを追加します。UserAddユーザーはロールの割り当てを追加します。 必須です。
assignmentState	String	割り当ての状態。 この値は、管理者によって直接割り当てられている場合や、ユーザーが対象の割Activeり当Activeてでアクティブ化する場合など、適格な割り当てに使用できますEligible。 使用可能な値は、NotStarted、Completed、RequestedApproval、Scheduled、Approved、ApprovalDenied、ApprovalAborted、Cancelling、Cancelled、Revoked、RequestExpired です。 必須です。
理由	String	監査とレビューの目的で、ロールの割り当て要求に理由を指定する必要があります。
schedule	governanceSchedule	ロールの割り当て要求のスケジュール。

応答

成功した場合、このメソッドは 201 Created 応答コードと応答本文の privilegedRoleAssignmentRequest オブジェクトを返します。

エラー コード

この API は、その標準 HTTP エラー コードを返します。 さらに、次の表に示すエラー コードを返すことができます。

エラー コード	エラー メッセージ
400 BadRequest	RoleAssignmentRequest プロパティが NULL でした
400 BadRequest	roleAssignmentRequest オブジェクトを逆シリアル化できません。
400 BadRequest	RoleId が必要です。
400 BadRequest	スケジュールの開始日を指定する必要があり、Now より大きくする必要があります。
400 BadRequest	このユーザー、ロール、およびスケジュールの種類のスケジュールは既に存在します。
400 BadRequest	このユーザー、ロール、承認の種類については、保留中の承認が既に存在します。
400 BadRequest	要求元の理由が見つかりません。
400 BadRequest	要求元の理由は 500 文字未満にする必要があります。
400 BadRequest	昇格期間は、0.5 ~ {from setting} である必要があります。
400 BadRequest	スケジュールされたアクティブ化と要求の間に重複があります。
400 BadRequest	このロールは、あらかじめアクティブ化されています。
400 BadRequest	GenericElevateUserToRoleAssignments: ライセンス認証プロセスで情報を刻む必要があり、提供されません。
400 BadRequest	スケジュールされたアクティブ化と要求の間に重複があります。
403 認証されていない	昇格には多要素認証が必要です。
403 認証されていない	昇格に代わっては許可されません。

例

要求

要求の例を次に示します。

HTTP

POST https://graph.microsoft.com/beta/privilegedRoleAssignmentRequests
Content-type: application/json

{
    "duration": "2",
    "reason": "Activate the role for business purpose",
    "ticketNumber": "234",
    "ticketSystem": "system",
    "schedule": {
        "startDateTime": "2018-02-08T02:35:17.903Z"
    },
    "type": "UserAdd",
    "assignmentState": "Active",
    "roleId": "88d8e3e3-8f55-4a1e-953a-9b9898b8876b"
}

C#

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var privilegedRoleAssignmentRequest = new PrivilegedRoleAssignmentRequestObject
{
    Duration = "2",
    Reason = "Activate the role for business purpose",
    TicketNumber = "234",
    TicketSystem = "system",
    Schedule = new GovernanceSchedule
    {
        StartDateTime = DateTimeOffset.Parse("2018-02-08T02:35:17.903Z")
    },
    Type = "UserAdd",
    AssignmentState = "Active",
    RoleId = "88d8e3e3-8f55-4a1e-953a-9b9898b8876b"
};

await graphClient.PrivilegedRoleAssignmentRequests
    .Request()
    .AddAsync(privilegedRoleAssignmentRequest);

重要

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 privilegedRoleAssignmentRequest = {
    duration: '2',
    reason: 'Activate the role for business purpose',
    ticketNumber: '234',
    ticketSystem: 'system',
    schedule: {
        startDateTime: '2018-02-08T02:35:17.903Z'
    },
    type: 'UserAdd',
    assignmentState: 'Active',
    roleId: '88d8e3e3-8f55-4a1e-953a-9b9898b8876b'
};

await client.api('/privilegedRoleAssignmentRequests')
    .version('beta')
    .post(privilegedRoleAssignmentRequest);

重要

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:@"/privilegedRoleAssignmentRequests"]]];
[urlRequest setHTTPMethod:@"POST"];
[urlRequest setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];

MSGraphPrivilegedRoleAssignmentRequest *privilegedRoleAssignmentRequest = [[MSGraphPrivilegedRoleAssignmentRequest alloc] init];
[privilegedRoleAssignmentRequest setDuration:@"2"];
[privilegedRoleAssignmentRequest setReason:@"Activate the role for business purpose"];
[privilegedRoleAssignmentRequest setTicketNumber:@"234"];
[privilegedRoleAssignmentRequest setTicketSystem:@"system"];
MSGraphGovernanceSchedule *schedule = [[MSGraphGovernanceSchedule alloc] init];
[schedule setStartDateTime: "2018-02-08T02:35:17.903Z"];
[privilegedRoleAssignmentRequest setSchedule:schedule];
[privilegedRoleAssignmentRequest setType:@"UserAdd"];
[privilegedRoleAssignmentRequest setAssignmentState:@"Active"];
[privilegedRoleAssignmentRequest setRoleId:@"88d8e3e3-8f55-4a1e-953a-9b9898b8876b"];

NSError *error;
NSData *privilegedRoleAssignmentRequestData = [privilegedRoleAssignmentRequest getSerializedDataWithError:&error];
[urlRequest setHTTPBody:privilegedRoleAssignmentRequestData];

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();

PrivilegedRoleAssignmentRequest privilegedRoleAssignmentRequest = new PrivilegedRoleAssignmentRequest();
privilegedRoleAssignmentRequest.duration = "2";
privilegedRoleAssignmentRequest.reason = "Activate the role for business purpose";
privilegedRoleAssignmentRequest.ticketNumber = "234";
privilegedRoleAssignmentRequest.ticketSystem = "system";
GovernanceSchedule schedule = new GovernanceSchedule();
schedule.startDateTime = OffsetDateTimeSerializer.deserialize("2018-02-08T02:35:17.903Z");
privilegedRoleAssignmentRequest.schedule = schedule;
privilegedRoleAssignmentRequest.type = "UserAdd";
privilegedRoleAssignmentRequest.assignmentState = "Active";
privilegedRoleAssignmentRequest.roleId = "88d8e3e3-8f55-4a1e-953a-9b9898b8876b";

graphClient.privilegedRoleAssignmentRequests()
    .buildRequest()
    .post(privilegedRoleAssignmentRequest);

重要

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

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

Go

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

requestBody := msgraphsdk.NewPrivilegedRoleAssignmentRequest()
duration := "2"
requestBody.SetDuration(&duration)
reason := "Activate the role for business purpose"
requestBody.SetReason(&reason)
ticketNumber := "234"
requestBody.SetTicketNumber(&ticketNumber)
ticketSystem := "system"
requestBody.SetTicketSystem(&ticketSystem)
schedule := msgraphsdk.NewGovernanceSchedule()
requestBody.SetSchedule(schedule)
startDateTime, err := time.Parse(time.RFC3339, "2018-02-08T02:35:17.903Z")
schedule.SetStartDateTime(&startDateTime)
type := "UserAdd"
requestBody.SetType(&type)
assignmentState := "Active"
requestBody.SetAssignmentState(&assignmentState)
roleId := "88d8e3e3-8f55-4a1e-953a-9b9898b8876b"
requestBody.SetRoleId(&roleId)
result, err := graphClient.PrivilegedRoleAssignmentRequests().Post(requestBody)

重要

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

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

PowerShell

Import-Module Microsoft.Graph.Identity.Governance

$params = @{
    Duration = "2"
    Reason = "Activate the role for business purpose"
    TicketNumber = "234"
    TicketSystem = "system"
    Schedule = @{
        StartDateTime = [System.DateTime]::Parse("2018-02-08T02:35:17.903Z")
    }
    Type = "UserAdd"
    AssignmentState = "Active"
    RoleId = "88d8e3e3-8f55-4a1e-953a-9b9898b8876b"
}

New-MgPrivilegedRoleAssignmentRequest -BodyParameter $params

重要

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


{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#privilegedRoleAssignmentRequests/$entity",
    "schedule": {
        "type": "activation",
        "startDateTime": "2018-02-08T02:35:17.903Z",
        "endDateTime": null,
        "duration" : null
    },
    "id": "e13ef8a0-c1cb-4d03-aaae-9cd1c8ede2d1",
    "type": "UserAdd",
    "assignmentState": "Active",
    "requestedDateTime": "2018-02-08T02:35:42.9137335Z",
    "status": "NotStarted",
    "duration": "2",
    "reason": "Activate the role for business purpose",
    "ticketNumber": "234",
    "ticketSystem": "system",
    "userId": "Self",
    "roleId": "88d8e3e3-8f55-4a1e-953a-9b9898b8876b"
}