privilegedRoleAssignment: makePermanent

11/10/2020
3 minutes to read

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Make the role assignment permanent.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

The tenant needs to be registered to PIM. Otherwise, HTTP 403 Forbidden error will be returned.

The requestor needs to have Privileged Role Administrator role.

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	Directory.AccessAsUser.All
Delegated (personal Microsoft account)	Not supported.
Application	Not supported.

HTTP request

POST /privilegedRoleAssignments/{id}/makePermanent

Request headers

Name	Description
Authorization	Bearer {token}. Required.

Request body

In the request body, provide a JSON object with the following parameters.

Parameter	Type	Description
reason	string	Optional. The reason to make this call.
ticketNumber	string	Optional. The ticket number that is associated with this action.
ticketSystem	string	Optional. The ticket system.

Response

If successful, this method returns 200 OK response code and privilegedRoleAssignment object in the response body.

Example

Here is an example of how to call this API.

Request

Here is an example of the request.

POST https://graph.microsoft.com/beta/privilegedRoleAssignments/{id}/makePermanent
Content-type: application/json
Content-length: 110

{
  "reason": "reason-value",
  "ticketNumber": "ticketNumber-value",
  "ticketSystem": "ticketSystem-value"
}


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var reason = "reason-value";

var ticketNumber = "ticketNumber-value";

var ticketSystem = "ticketSystem-value";

await graphClient.PrivilegedRoleAssignments["{id}"]
	.MakePermanent(reason,ticketNumber,ticketSystem)
	.Request()
	.PostAsync();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

Read the SDK documentation for details about how to add the SDK to your project and create an authProvider instance.


const options = {
	authProvider,
};

const client = Client.init(options);

const privilegedRoleAssignment = {
  reason: "reason-value",
  ticketNumber: "ticketNumber-value",
  ticketSystem: "ticketSystem-value"
};

let res = await client.api('/privilegedRoleAssignments/{id}/makePermanent')
	.version('beta')
	.post(privilegedRoleAssignment);

Important

Read the SDK documentation for details about how to add the SDK to your project and create an authProvider instance.


MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

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

NSMutableDictionary *payloadDictionary = [[NSMutableDictionary alloc] init];

NSString *reason = @"reason-value";
payloadDictionary[@"reason"] = reason;

NSString *ticketNumber = @"ticketNumber-value";
payloadDictionary[@"ticketNumber"] = ticketNumber;

NSString *ticketSystem = @"ticketSystem-value";
payloadDictionary[@"ticketSystem"] = ticketSystem;

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];

Important

Read the SDK documentation for details about how to add the SDK to your project and create an authProvider instance.


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

String reason = "reason-value";

String ticketNumber = "ticketNumber-value";

String ticketSystem = "ticketSystem-value";

graphClient.privilegedRoleAssignments("{id}")
	.makePermanent(reason,ticketNumber,ticketSystem)
	.buildRequest()
	.post();

Important

Read the SDK documentation for details about how to add the SDK to your project and create an authProvider instance.

Response

Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 200 OK
Content-type: application/json
Content-length: 184

{
  "id": "id-value",
  "userId": "userId-value",
  "roleId": "roleId-value",
  "isElevated": true,
  "expirationDateTime": "2016-10-19T10:37:00Z",
  "resultMessage": "resultMessage-value"
}

privilegedRoleAssignment: makePermanent

Permissions

HTTP request

Request headers

Request body

Response

Example

Request

Response

Is this page helpful?

Feedback

Is this page helpful?