Integrate enmeshed

AuthenticationRequestItem

With the AuthenticationRequestItem the sender can request the peer for an authentication in a business context for a certain purpose. The peer can then decide to authenticate or not. This authentication is mostly short-lived and limited in time.

Examples

  • Authentication for a login to a website
  • Authentication for opening a door

Response Parameters

Item Properties

Parameters

ConsentRequestItem

With the ConsentRequestItem it is possible to request a consent of the peer to an arbitrary text and thus reach agreement on a certain non machine-processable context.

To request an accept/reject decision from a peer to a free text, the ConsentRequestItem is used.

Please do not use the ConsentRequestItem to submit tons of text to the peer Identity. It is meant to be a short consent or summary the user agrees to. Please move longer text to external websites. The ConsentRequestItem is also not meant for contractual agreements.

Examples

  • “I hereby confirm that I have read the privacy terms of this cloud service and agree to them.”
  • “The provided EULA has been read and agreed to.”
  • “Yes, I have backed up all of my data of this PC and you can wipe it.”
  • “I opt in to the newsletter.”

Response Parameters

Item Properties

Parameters

CreateAttributeRequestItem

If you want to create Identity- or RelationshipAttributes for the peer, the CreateAttributeRequestItem can be used. Please have a look at the ProposeAttributeRequestItem if the peer should be able to overwrite the Attribute.

To create an Attribute with a fixed value defined by the sender, an Identity uses the CreateAttributeRequestItem. A fixed value in this case means, that the recipient is not allowed to change the value when accepting the request.

Examples

Examples of use cases for the CreateAttributeRequestItem can be found in the Create Attribute for peer guide.

Response

Item Properties

Parameters

Combinations and usage scenarios

Combinations and usage scenarios of the CreateAttributeRequestItem can be found in the Create Attribute for peer guide.

FreeTextRequestItem

With the FreeTextRequestItem it is possible to send a free text to the peer. The peer itself can accept this with a free text as well.

Response Parameters

Item Properties

Parameters

ProposeAttributeRequestItem

The ProposeAttributeRequestItem is a combination of ReadAttributeRequestItem and CreateAttributeRequestItem. The sender would like to receive a correct Attribute from the peer, thinks it has a possible value but the peer might overrule this value with an existing or new one.

To create an Attribute with a value proposed by the sender, an Identity uses the ProposeAttributeRequestItem. A proposed value in this case means, that the recipient is allowed to change the value if accepting the request.

Examples

Examples of use cases for the ProposeAttributeRequestItem can be found in the Propose Attribute to peer guide.

Response

Item Properties

Parameters

Combinations and usage scenarios

Combinations and usage scenarios of the ProposeAttributeRequestItem can be found in the Propose Attribute to peer guide.

ReadAttributeRequestItem

If you want to query an Identity’s Attributes this is done with the ReadAttributeRequestItem.

To query Attributes which are not known to the sender, an Identity uses the ReadAttributeRequestItem.

Examples

Examples of use cases for the ReadAttributeRequestItem can be found in the Read Attribute from peer guide.

Response

Item Properties

Parameters

Combinations and usage scenarios

Combinations and usage scenarios of the ReadAttributeRequestItem can be found in the Read Attribute from peer guide.

RegisterAttributeListenerRequestItem

This item is used to register a Listener for a specific Attribute. The Listener will create a Request in status Draft if an Attribute was created that matches the given query and the user is able to send the Request to the creator of the RegisterAttributeListenerRequestItem.

Examples

  • Asking for a specific RelationshipAttribute of a partner organization.

Response

Item Properties

Parameters

ShareAttributeRequestItem

If you want to share the own DisplayName and possibly other Attributes this is done with the ShareAttributeRequestItem.

To share own IdentityAttributes (owner = self) an Identity uses the ShareAttributeRequestItem. The Identity needs to create the IdentityAttribute separately before the Attribute can be shared.

Examples

Examples of use cases for the ShareAttributeRequestItem can be found in the Share own Attribute to peer guide.

Response

Item Properties

Parameters

Combinations and usage scenarios

Combinations and usage scenarios of the ShareAttributeRequestItem can be found in the Share own Attribute to peer guide.