Edit

accessPackageResourceAttribute 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.

An access package resource attribute is the definition of a property that a user is required to have to be able to access an application. This structure is included in an accessPackageResource of a catalog, for an application whose roles are included in an access package in that catalog. When a user requests the access package, they must supply the value of the attribute, which, if the request is approved, is then written on the user's directory object. The application can then subsequently read the attribute of the user.

Properties

Property Type Description
attributeDestination accessPackageResourceAttributeDestination Information about how to set the attribute, currently a accessPackageUserDirectoryAttributeStore object type.
attributeName String The name of the attribute in the end system. If the destination is accessPackageUserDirectoryAttributeStore, then a user property such as jobTitle or a directory schema extension for the user object type, such as extension_2b676109c7c74ae2b41549205f1947ed_personalTitle.
attributeSource accessPackageResourceAttributeSource Information about how to populate the attribute value when an accessPackageAssignmentRequest is being fulfilled, currently a accessPackageResourceAttributeQuestion object type.
id String Unique identifier for the attribute on the access package resource. Read-only.
isEditable String Specifies whether or not an existing attribute value can be edited by the requester.
isPersistedOnAssignmentRemoval Boolean Specifies whether the attribute will remain in the end system after an assignment ends.

accessPackageResourceAttribute resource type and extension properties

The attributeDestination, attributeName, and attributeSource properties of an access package resource attribute relate to the directory extension properties.

If the attributeDestination is an accessPackageUserDirectoryAttributeStore object type, then the attribute indicated by attributeName must be a writable property of the user object. These writable properties are String types registered as extension properties on the target User object.

For example, suppose an application requires two user attributes, a user's job title, and their personal title. The values of these attributes could be synchronized to Microsoft Entra ID from the on-premises Active Directory jobTitle and personalTitle attributes. Because personalTitle is not one of the default properties of the user object, this would require creating a directory schema extension to add the personalTitle property to the user object type. When creating a resource request for the application, you can include two access package resource attributes, one for the user property jobTitle, and another with the name of the directory schema extension property that was created for the personal title, such as extension_2b676109c7c74ae2b41549205f1947ed_personalTitle.

If the attributeSource of the attribute is an accessPackageResourceAttributeQuestion, then the requestor's supplied value is stored as provided on the user object, and made available to the application and other Microsoft Graph clients.

Relationships

None.

JSON representation

The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.accessPackageResourceAttribute",
  "attributeDestination": {
    "@odata.type": "microsoft.graph.accessPackageResourceAttributeDestination"
  },
  "attributeName": "String",
  "attributeSource": {
    "@odata.type": "microsoft.graph.accessPackageResourceAttributeSource"
  },
  "id": "String (identifier)",
  "isEditable": "Boolean",
  "isPersistedOnAssignmentRemoval": "Boolean"
}