| 1 Definition | 2 Functional Requirements | 3 Syntax | 4 Semantics |
1 Definition
The Process Action of a User sending an Authentication Request Item to request that an Information Service:
- Confirm that an Item or Process is what it claims to be.
- Grant Rights to the Authentication Response Item based on requested Rights (Status=Model).
If the request is accepted, the Information Service responds with an Authentication Response Item including Rights (Status=Final).
2 Protocol
The protocol is described using Natural Language by the sequence of actions below:
- A User Process sends to Authenticate Service Authenticate PA Request containing Authentication and Rights (Status=Model) to be acquired on the Authentication object.
- If Authenticate Service is a free service, then go to Authenticate.
- If Authenticate Service is a pay service:
- The User Process sends Authenticate PA Request to the Authenticate Service. The Request contains the Authentication object and the Service Pricing Model (Status=Model) describing the terms governing the exchange.
- Authenticate Service returns Authenticate PA Response:
- If Authenticate PA Response contains Status=Err, then go to End.
- If Authenticate PA Response contains Status=Ack and the Service Pricing Model proposes a Transaction (both Status=Model), then the User Process:
- Transacts Value described in Transaction (Status=Model).
- Sends Authenticate PA Request, to Authenticate Service, containing the Service Pricing Model with the Transaction (Status=Final).
- Authenticate: Authenticate Service sends to User “Authenticate PA Response” containing:
- Authentication and Rights (Status=Final).
- Service Pricing Model (Status=Final), if Authenticate is a pay Service.
- End
The protocol described using Workflow Description Language (WDL) is available at this link:
https://schemas.mpai.community/MMM4/V2.2/actions/AuthenticatePA.wdl
3 Syntax
The structure of the input and output messages, using JavaScript Object Notation (JSON) is available at this link:
https://schemas.mpai.community/MMM4/V2.2/actions/AuthenticatePA.json
4 Semantics
The semantic of the JSON keys is described in the table below:
| Label | Description |
| Header | Authenticate Process Action Header – Standard “MMM-AUP-Vx.y” |
| MInstanceID | Identifier of M-Instance. |
| MEnvironmentID | Identifier of M-Environment. |
| AuthenticatePAData | Data of the Authenticate PA Item. |
| – Time | Times of PA request emission and PA request execution. |
| – RQ-Complements | Source Complements. |
| – With Authentication | The Authentication Request Item. |
| – With Rights | Requested Rights (Status=Model) on the Authentication Response. |
| – With SPM | Service Pricing Model, if Authenticate is a pay Service. |
| – RS-Complements | Complements in the PA Response. |
| – With Authentication | Authentication Response Item. |
| – With Rights | Rights (Status=Final) based on Model Rights if PA Request is accepted. |
| – With SPM | Service Pricing Model completed by Authenticate Service. |
| – With PAStatus | PA Request Status. |
| – Ack | If PA Request could be performed. |
| – Err | If PA Request could not be performed. |
| – FaultyPA | Faulty PA Request. |
| – IncID | Incorrect ID. |
| – LocOOR | Location out of range. |
| – InsRights | Insufficient Rights. |
| – InsValue | Insufficient Value in Wallet. |
| DataExchangeMetadata | Metadat ensuring correct transfer of information from Source to Destination. |
| Trace | Authentication provenance information and time of PA production. |
| DescMetadata | Descriptive Metadata. |