Parties (single party) [PATCH]

The PATCH request to the /parties/{partyId} endpoint can be used to partially update information of an iSHARE participant in the Participant Registry (name and alsoKnownAs). Only the provided fields will be updated, other fields remain unchanged. The partyId cannot be changed through this operation. To update information stored in claims, use the PATCH method on claims instead.

The PATCH request to the /parties/{partyId} is an OPTIONAL endpoint.

Update party information

patch

Used to partially update information of an iSHARE participant in the Participant Registry. Only the provided fields will be updated, other fields remain unchanged. The party ID cannot be changed through this operation. Server response is an iSHARE signed JSON Web Token. Please refer to the models 'jwtHeader' and 'jwtPayloadPartyToken' which indicate what the decoded response will look like.

Authorizations
AuthorizationstringRequired

OAuth 2.0 authorization based on bearer token. MUST contain “Bearer “ + access token value. Must be provided if restricted endpoints are needed.

Path parameters
partyIdstringRequired

The id of the party whose record must be updated. Can be anyone of the party id from id or alsoKnownAs attributes of that participant. Since all participants are automatically allocated the derived ishare did, that id is always an option to search for a participant.

Example: did:ishare:EU.NL.NTRNL-12345678
Body

Schema for partial updates to a party. All fields are optional. Only provided fields will be updated. The ID cannot be updated.

namestringOptional

Name of the party.

Example: Example Corporation
alsoKnownAsstring[]Optional

Array of registered party ids of the party with which the party is also identified. Optional, because a party could be identified with only its did:ishare (in the 'id' property).

Example: ["did:ishare:EU.NL.NTRNL-12345678","did:ebsi:LEIXG-724500AZSGBRY55MNS59","did:web:example.com","CoC:123456789"]
Responses
200

OK

application/json
patch
/parties/{partyId}

Request model

The following URL parameter must be used.

  • partyId {url}/parties/{partyId} required String. The id of the party who must be fetched. Can be anyone of the party id from id or alsoKnownAs attributes of that participant. Since all participants are automatically allocated the derived ishare did, that id is always an option to search for a participant.

The request must be passed as JWT. The JSON model in the JWT is as follows.

  • name String. Root level. (Required) Name of the party.

  • alsoKnownAs Array of strings. Contained in partyInfo. Array of registered party ids of the party with which the party is also identified. Optional, because a party could be identified with only its iSHARE-ID (in the 'id' property). When updating alsKnownAs all existing values must also be provided. Implementations should raise an error if any of the existing values are missing (meaning deletion) as Ids in this field cannot be deleted once registered.

Example request

Response model

The response will be equal to the response of the GET request for retrieving a single party. Please refer to the response model as defined here.

Example response

Please also refer to the example response under the GET request definition.

PreviousParties (single party) [OPTIONS]NextClaims [GET]

Last updated