Edit

Share via

userConsentRequest resource type

  • Article

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.

Represents the details of the consent request a user creates when they request to access an app or to grant permissions to an app. The details include justification for requesting access, the status of the request, and the approval details.

The user can create a consent request when an app or a permission requires admin authorization and only when the admin consent workflow is enabled.

Methods

Method Return type Description
List userConsentRequest collection Retrieve a collection of userConsentRequest objects for an appConsentRequest.
Get userConsentRequest Read the properties and relationships of a userConsentRequest object.
Filter by current user userConsentRequest collection Read the properties of userConsentRequest objects for an appConsentRequest for which the current user is the reviewer.

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, Expired, and Completed. Supports $filter (eq only) and $orderby.

Relationships

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

JSON representation

The following JSON representation shows the resource type.

{
  "@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"
}