Skip to content

Latest commit

 

History

History
55 lines (42 loc) · 1.53 KB

get-claim-by-id.md

File metadata and controls

55 lines (42 loc) · 1.53 KB

Get Claim by ID

{% swagger method="get" path="/api/v1/{entity-name}/claims/{claimId}" baseUrl=" " summary="" expanded="true" %} {% swagger-description %}

{% endswagger-description %}

{% swagger-parameter in="path" name="entity-name" required="true" %} Name of the entity to which attestation request was sent {% endswagger-parameter %}

{% swagger-parameter in="header" name="content-type" required="true" %} Set to application/json {% endswagger-parameter %}

{% swagger-parameter in="header" name="authorization" %} Set to Bearer {access-token} if roles in schema config is not anonymous else this can be empty {% endswagger-parameter %}

{% swagger-parameter in="path" name="claimId" required="true" %} ID of the claim to be returned {% endswagger-parameter %}

{% swagger-response status="200: OK" description="" %}

{
    "id": "{claimId}",
    "entity": "{entityName",
    "entityId": "{entityId}",
    "status": "OPEN",
    "attestationId": "{attestationID}",
    "attestationName": "{attestationName}",
    "closed": false        
}

{% endswagger-response %} {% endswagger %}

Usage

cURL

curl --location --request GET '{registry-url}/api/v1/{entity-name}/claims/{claimId}' \
--header 'Authorization: Bearer {access-token}'

HTTPie

http GET '{registry-url}/api/v1/{entity-name}/claims/{claimId}' \
 Authorization:'Bearer {access-token}'

{registry-url} is usually http://localhost:{port}. The port can be found under the registry section in the docker-compose.yml file and is usually 8081