access_reviews_definitions_instances_contacted_reviewers

Creates, updates, deletes, gets or lists an access_reviews_definitions_instances_contacted_reviewers resource.

Overview

Name	access_reviews_definitions_instances_contacted_reviewers
Type	Resource
Id	entra_id.identity_governance.access_reviews_definitions_instances_contacted_reviewers

Fields

The following fields are returned by SELECT queries:

get

Retrieved navigation property

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
createdDateTime	string (date-time)	The date when the reviewer was added for the access review. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
displayName	string	Name of reviewer.
userPrincipalName	string	User principal name of the reviewer.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
createdDateTime	string (date-time)	The date when the reviewer was added for the access review. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
displayName	string	Name of reviewer.
userPrincipalName	string	User principal name of the reviewer.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	access_review_schedule_definition_id, access_review_instance_id, access_review_reviewer_id		Returns the collection of reviewers who were contacted to complete this review. While the reviewers and fallbackReviewers properties of the accessReviewScheduleDefinition might specify group owners or managers as reviewers, contactedReviewers returns their individual identities. Supports $select. Read-only.
list	select	access_review_schedule_definition_id, access_review_instance_id		Get the reviewers for an access review instance, irrespective of whether or not they have received a notification. The reviewers are represented by an accessReviewReviewer object. A list of zero or more objects are returned, including all of their nested properties.
insert	insert	access_review_schedule_definition_id, access_review_instance_id
update	update	access_review_schedule_definition_id, access_review_instance_id, access_review_reviewer_id
delete	delete	access_review_schedule_definition_id, access_review_instance_id, access_review_reviewer_id	If-Match

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
access_review_instance_id	string	The unique identifier of accessReviewInstance
access_review_reviewer_id	string	The unique identifier of accessReviewReviewer
access_review_schedule_definition_id	string	The unique identifier of accessReviewScheduleDefinition
If-Match	string	ETag

SELECT examples

get

Returns the collection of reviewers who were contacted to complete this review. While the reviewers and fallbackReviewers properties of the accessReviewScheduleDefinition might specify group owners or managers as reviewers, contactedReviewers returns their individual identities. Supports $select. Read-only.

SELECT
id,
createdDateTime,
displayName,
userPrincipalName
FROM entra_id.identity_governance.access_reviews_definitions_instances_contacted_reviewers
WHERE access_review_schedule_definition_id = '{{ access_review_schedule_definition_id }}' -- required
AND access_review_instance_id = '{{ access_review_instance_id }}' -- required
AND access_review_reviewer_id = '{{ access_review_reviewer_id }}' -- required
;

list

Get the reviewers for an access review instance, irrespective of whether or not they have received a notification. The reviewers are represented by an accessReviewReviewer object. A list of zero or more objects are returned, including all of their nested properties.

SELECT
id,
createdDateTime,
displayName,
userPrincipalName
FROM entra_id.identity_governance.access_reviews_definitions_instances_contacted_reviewers
WHERE access_review_schedule_definition_id = '{{ access_review_schedule_definition_id }}' -- required
AND access_review_instance_id = '{{ access_review_instance_id }}' -- required
;

INSERT examples

insert

No description available.

INSERT INTO entra_id.identity_governance.access_reviews_definitions_instances_contacted_reviewers (
id,
createdDateTime,
displayName,
userPrincipalName,
access_review_schedule_definition_id,
access_review_instance_id
)
SELECT 
'{{ id }}',
'{{ createdDateTime }}',
'{{ displayName }}',
'{{ userPrincipalName }}',
'{{ access_review_schedule_definition_id }}',
'{{ access_review_instance_id }}'
RETURNING
id,
createdDateTime,
displayName,
userPrincipalName
;

Manifest

# Description fields are for documentation purposes
- name: access_reviews_definitions_instances_contacted_reviewers
props:
  - name: access_review_schedule_definition_id
    value: "{{ access_review_schedule_definition_id }}"
    description: Required parameter for the access_reviews_definitions_instances_contacted_reviewers resource.
  - name: access_review_instance_id
    value: "{{ access_review_instance_id }}"
    description: Required parameter for the access_reviews_definitions_instances_contacted_reviewers resource.
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: createdDateTime
    value: "{{ createdDateTime }}"
    description: |
      The date when the reviewer was added for the access review.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Name of reviewer.
  - name: userPrincipalName
    value: "{{ userPrincipalName }}"
    description: |
      User principal name of the reviewer.

UPDATE examples

update

No description available.

UPDATE entra_id.identity_governance.access_reviews_definitions_instances_contacted_reviewers
SET 
id = '{{ id }}',
createdDateTime = '{{ createdDateTime }}',
displayName = '{{ displayName }}',
userPrincipalName = '{{ userPrincipalName }}'
WHERE 
access_review_schedule_definition_id = '{{ access_review_schedule_definition_id }}' --required
AND access_review_instance_id = '{{ access_review_instance_id }}' --required
AND access_review_reviewer_id = '{{ access_review_reviewer_id }}' --required
RETURNING
id,
createdDateTime,
displayName,
userPrincipalName;

DELETE examples

delete

No description available.

DELETE FROM entra_id.identity_governance.access_reviews_definitions_instances_contacted_reviewers
WHERE access_review_schedule_definition_id = '{{ access_review_schedule_definition_id }}' --required
AND access_review_instance_id = '{{ access_review_instance_id }}' --required
AND access_review_reviewer_id = '{{ access_review_reviewer_id }}' --required
AND If-Match = '{{ If-Match }}'
;