Share via

Request

  • Article

The Request resource represents a message that is used on the wire. When a Web service request to create, update or delete a resource is received by the FIM Service, that request is translated into a Request resource as described in Request Processing.

Schema

<?xml version="1.0"?><xs:schema xmlns:rm="https://schemas.microsoft.com/2006/11/ResourceManagement" targetNamespace="https://schemas.microsoft.com/2006/11/ResourceManagement" version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType name="Request">
    <xs:sequence>
      <xs:element minOccurs="0" name="ObjectID" type="rm:ReferenceType" />
      <xs:element minOccurs="1" name="ObjectType">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="1" name="CreatedTime" type="xs:dateTime" />
      <xs:element minOccurs="0" name="Creator" type="rm:ReferenceType" />
      <xs:element minOccurs="0" name="MVObjectID">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="DeletedTime" type="xs:dateTime" />
      <xs:element minOccurs="0" name="Description">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="DetectedRulesList" type="rm:ReferenceCollectionType" />
      <xs:element minOccurs="0" name="DisplayName">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="ExpectedRulesList" type="rm:ReferenceCollectionType" />
      <xs:element minOccurs="0" name="ExpirationTime" type="xs:dateTime" />
      <xs:element minOccurs="0" name="Locale">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="ResourceTime" type="xs:dateTime" />
      <xs:element minOccurs="0" name="ActionWorkflowInstance" type="rm:ReferenceCollectionType" />
      <xs:element minOccurs="0" name="AuthenticationWorkflowInstance" type="rm:ReferenceCollectionType" />
      <xs:element minOccurs="0" name="AuthorizationWorkflowInstance" type="rm:ReferenceCollectionType" />
      <xs:element minOccurs="0" name="CommittedTime" type="xs:dateTime" />
      <xs:element minOccurs="0" name="ComputedActor" type="rm:ReferenceCollectionType" />
      <xs:element minOccurs="0" name="HasCollateralRequest" type="xs:boolean" />
      <xs:element minOccurs="0" name="ManagementPolicy" type="rm:ReferenceCollectionType" />
      <xs:element minOccurs="1" name="Operation">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value="^(Create|Get|Put|Delete|Enumerate|Pull|SystemEvent)$" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="ParentRequest" type="rm:ReferenceType" />
      <xs:element minOccurs="0" name="RequestControl">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value="^(CancelOperation|CancelActionWorkflow)$" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="RequestParameter" type="rm:TextCollectionType" />
      <xs:element minOccurs="1" name="RequestStatus">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value="^(NotFound|Denied|Validating|Canceling|Validated|Authenticating|Authenticated|Authorizing|Authorized|Failed|Canceled|Committed|CanceledPostProcessing|PostProcessing|PostProcessingError|Completed)$" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="RequestStatusDetail" type="rm:TextCollectionType" />
      <xs:element minOccurs="0" name="SetTransition" type="rm:TextCollectionType" />
      <xs:element minOccurs="0" name="Target" type="rm:ReferenceType" />
      <xs:element minOccurs="0" name="TargetObjectType">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
</xs:schema>

Properties

The following table lists the properties of the Request resource:

Property Description

ActionWorkflowInstance

Optional multi-valued property. Reference to a WorkflowInstance that represents an action workflow instance.

AuthenticationWorkflowInstance

Optional multi-valued property. Reference to a WorkflowInstance that represents an authentication workflow instance.

AuthorizationWorkflowInstance

Optional multi-valued property. Reference to a WorkflowInstance that represents an authorization workflow instance.

CommittedTime

Optional dateTime property. Indicates the time that the Request was committed to the FIM Service database.

ComputedActor

Optional multi-valued reference property that is populated by the FIM Service. This property is used to set up permissions.

HasCollateralRequest

Optional Boolean property. A value of true indicates that the Request requires action workflows to be run on alternate target resources and must wait for these collateral requests to finish before it can be completed.

ManagementPolicy

Optional multi-valued property that contains references to ManagementPolicyRule resources that were triggered by the request. See Working with ManagementPolicyRule Objects.

Operation

Required property. String indicating the request operation. Valid values are:

  • Create

  • Delete

  • Put

  • SystemEvent

Request resources are not created for read or query requests. See Request Processing.

ParentRequest

Optional property. Reference to the Request resource that caused this Request to be created.

RequestControl

Optional String property. Allows a client to control the execution of a Request based on values provided for the attribute.Valid values are:

  • CancelOperation

  • CancelActionWorkflow

RequestParameter

Optional multi-valued String property. Serialized strongly typed request parameter that describes the details of an operation associated with a request.

RequestStatus

Required property. The status of the request. See Request Processing. Valid values are:

  • Not Found

  • Denied

  • Validating

  • Canceling

  • Validated

  • Authenticating

  • Authenticated

  • Authorizing

  • Authorized

  • Failed

  • Canceled

  • Committed

  • CanceledPostProcessing

  • PostProcessing

  • PostProcessingError

  • Completed

RequestStatusDetail

Optional multi-valued String property. Workflows can store comments from activities in this property.

Target

Optional property. Reference to the target of the Request's operation.

TargetObjectType

Optional String property. Indicates the ObjectType of the Resource referenced by the Target property. The String length must be no more than 448 characters.

Parent Elements

None

Remarks

All of the resource types in FIM have the same attribute bindings as the Resource type by default. For more information, see Forefront Identity Manager Schema.

See Also

Concepts

Request Processing
Schema Data Types
How to: Retrieve the FIM Service Schema Using WS-MetadataExchange

Other Resources

Forefront Identity Manager Schema