userConsentRequest resource type

Namespace: microsoft.graph

A userConsentRequest is created by an user when they are requesting access to an application which requires an admin authorization to access.

Methods

Method Return type Description
List userConsentRequests userConsentRequest collection Get a list of the userConsentRequest objects and their properties.
Get userConsentRequest userConsentRequest Read the properties and relationships of a userConsentRequest object.
List userConsentRequests: filterByCurrentUser userConsentRequest collection Get a list of the userConsentRequest objects and their properties.

Properties

Property Type Description
approvalId String The id of the approval. This value is equal to the value of the id.
completedDateTime DateTimeOffset The date and time when the status of the request was marked as Completed. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
createdBy identitySet The user who created the request.
createdDateTime DateTimeOffset The date and time when the request was created. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
Supports $filter (eq only) and $orderby.
customData String Free text field to define any custom data for the user consent request. Not used.
id String Identifier of the request.
reason String The user's justification for requiring access to the app. Supports $filter (eq only) and $orderby.
status String The status of the user's app consent request. Possible values are: Initializing, InProgress, and Completed. Supports $filter (eq only) and $orderby.

Relationships

Relationship Type Description
approval approval Approval decisions associated with a request.

JSON representation

The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.userConsentRequest",
  "id": "String (identifier)",
  "status": "String",
  "completedDateTime": "String (timestamp)",
  "createdDateTime": "String (timestamp)",
  "approvalId": "String",
  "customData": "String",
  "createdBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "reason": "String"
}