rejected_senders

Creates, updates, deletes, gets or lists a rejected_senders resource.

Overview

Name	rejected_senders
Type	Resource
Id	entra_id.groups.rejected_senders

Fields

The following fields are returned by SELECT queries:

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
deletedDateTime	string (date-time)	Date and time when this object was deleted. Always null when the object hasn't been deleted. (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])$)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	group_id		Users in the rejected senders list can't post to conversations of the group (identified in the GET request URL). Make sure you don't specify the same user or group in the rejected senders and accepted senders lists, otherwise you get an error.
add_ref	insert	group_id		Specify the user or group in @odata.id in the request body. Users in the rejected senders list can't post to conversations of the group (identified in the POST request URL). Make sure you don't specify the same user or group in the rejected senders and accepted senders lists, otherwise you'll get an error.
remove_ref	delete	group_id, directory_object_id	If-Match
remove_ref_2	delete	group_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
directory_object_id	string	The unique identifier of directoryObject
group_id	string	The unique identifier of group
If-Match	string	ETag

SELECT examples

list

Users in the rejected senders list can't post to conversations of the group (identified in the GET request URL). Make sure you don't specify the same user or group in the rejected senders and accepted senders lists, otherwise you get an error.

SELECT
id,
deletedDateTime
FROM entra_id.groups.rejected_senders
WHERE group_id = '{{ group_id }}' -- required
;

INSERT examples

add_ref

Specify the user or group in @odata.id in the request body. Users in the rejected senders list can't post to conversations of the group (identified in the POST request URL). Make sure you don't specify the same user or group in the rejected senders and accepted senders lists, otherwise you'll get an error.

INSERT INTO entra_id.groups.rejected_senders (
directoryObjectId,
group_id
)
SELECT 
'{{ directoryObjectId }}',
'{{ group_id }}'
;

Manifest

# Description fields are for documentation purposes
- name: rejected_senders
props:
  - name: group_id
    value: "{{ group_id }}"
    description: Required parameter for the rejected_senders resource.
  - name: directoryObjectId
    value: "{{ directoryObjectId }}"
    description: |
      The id of the directory object to reference (a user, group, service principal, device, ...). Sent on the wire as '@odata.id': 'https://graph.microsoft.com/v1.0/directoryObjects/{id}'.

DELETE examples

remove_ref

No description available.

DELETE FROM entra_id.groups.rejected_senders
WHERE group_id = '{{ group_id }}' --required
AND directory_object_id = '{{ directory_object_id }}' --required
AND If-Match = '{{ If-Match }}'
;

remove_ref_2

No description available.

DELETE FROM entra_id.groups.rejected_senders
AND group_id = '{{ group_id }}' --required
AND If-Match = '{{ If-Match }}'
;