delegatedAdminRelationship resource type

Namespace: microsoft.graph

Represents a delegated admin relationship between a partner and customer.

Methods

Method Return type Description
Create delegatedAdminRelationship delegatedAdminRelationship Create a new delegatedAdminRelationship object.
List delegatedAdminRelationships delegatedAdminRelationship collection Get a list of the delegatedAdminRelationship objects and their properties.
Get delegatedAdminRelationship delegatedAdminRelationship Read the properties and relationships of a delegatedAdminRelationship object.
Update delegatedAdminRelationship delegatedAdminRelationship Update the properties of a delegatedAdminRelationship object.
Delete delegatedAdminRelationship None Delete a delegatedAdminRelationship object.

Properties

Property Type Description
accessDetails delegatedAdminAccessDetails The access details containing the identifiers of the administrative roles that the partner admin is requesting in the customer tenant.
activatedDateTime DateTimeOffset The date and time in ISO 8601 format and in UTC time when the relationship became active. Read-only.
createdDateTime DateTimeOffset The date and time in ISO 8601 format and in UTC time when the relationship was created. Read-only.
customer delegatedAdminRelationshipCustomerParticipant The display name and unique identifier of the customer of the relationship. This is configured either by the partner at the time the relationship is created or by the system after the customer approves the relationship. Cannot be changed by the customer.
displayName String The display name of the relationship used for ease of identification. Must be unique across all delegated admin relationships of the partner. This is set by the partner only when the relationship is in the created status and cannot be changed by the customer.
duration Duration The duration of the relationship in ISO 8601 format. Must be a value between P1D and P2Y inclusive. This is set by the partner only when the relationship is in the created status and cannot be changed by the customer.
endDateTime DateTimeOffset The date and time in ISO 8601 format and in UTC time when the status of relationship changes to either terminated or expired. Calculated as endDateTime = activatedDateTime + duration. Read-only.
id String The unique identifier of the relationship. Read-only. Inherited from entity.
lastModifiedDateTime DateTimeOffset The date and time in ISO 8601 format and in UTC time when the relationship was last modified. Read-only.
status delegatedAdminRelationshipStatus The status of the relationship. Read Only. The possible values are: activating, active, approvalPending, approved, created, expired, expiring, terminated, terminating, terminationRequested, unknownFutureValue. Supports $orderBy.

delegatedAdminRelationshipStatus values

Member Description
created The partner has created a new relationship. In this state, the relationship can be modified.
approvalPending The partner has finalized the relationship through the lockForApproval action of a delegatedAdminRelationshipRequest object.
approved The customer has approved the relationship through the approve action of a delegatedAdminRelationshipRequest object.
activating The system starts provisioning of the relationship.
active The system completes the provisioning of the relationship.
expiring The relationship has passed its expiration date.
expired The system completes the de-provisioning of the relationship.
terminationRequested The partner or customer has requested termination of the relationship through the terminate action of a delegatedAdminRelationshipRequest object.
terminating The system starts de-provisioning the relationship.
terminated The system has completed de-provisioning the relationship.
unknownFutureValue Evolvable enumeration sentinel value. Do not use.

Relationships

Relationship Type Description
accessAssignments delegatedAdminAccessAssignment collection The access assignments associated with the delegated admin relationship.
operations delegatedAdminRelationshipOperation collection The long running operations associated with the delegated admin relationship.
requests delegatedAdminRelationshipRequest collection The requests associated with the delegated admin relationship.

JSON representation

The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.delegatedAdminRelationship",
  "id": "String (identifier)",
  "displayName": "String",
  "duration": "String",
  "customer": {
    "@odata.type": "microsoft.graph.delegatedAdminRelationshipCustomerParticipant"
  },
  "accessDetails": {
    "@odata.type": "microsoft.graph.delegatedAdminAccessDetails"
  },
  "status": "String",
  "createdDateTime": "String (timestamp)",
  "lastModifiedDateTime": "String (timestamp)",
  "activatedDateTime": "String (timestamp)",
  "endDateTime": "String (timestamp)"
}