Inrupt WebsiteSupport Center

Accessgrants

Retrieve specific access grant by UUID

get
Path parameters
IDstringRequired

The ID of the access grant

Responses
200

Access grant details.

application/json
get
/accessgrants/{ID}
GET /accessgrants/{ID} HTTP/1.1
Host: api.wallet.example.com
Accept: */*

{
  "resource": "text",
  "accessRequestUri": "text",
  "expirationDate": "text",
  "forPurpose": "text",
  "mode": [
    "text"
  ]
}

Revoke an access grant

put
Path parameters
IDstringRequired

The ID of the access grant

Body
statusstringRequired

Revoked

Responses
204

Access grant revoked.

No content
put
/accessgrants/{ID}
PUT /accessgrants/{ID} HTTP/1.1
Host: api.wallet.example.com
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "status": "revoked"
}
No content

List all active access grants

get
Query parameters
allbooleanOptional

Return whole body of full valid access grants if true.

Default: false
Responses
200

List of access grants.

application/json
get
/accessgrants
GET /accessgrants HTTP/1.1
Host: api.wallet.example.com
Accept: */*
200

List of access grants.

[
  {
    "resource": "text",
    "accessRequestUri": "text",
    "expirationDate": "text",
    "forPurpose": "text",
    "mode": [
      "text"
    ]
  }
]

Create a new access grant

post
Body
resourcestringOptional
accessRequestUristringOptional
expirationDatestringOptional
forPurposestringOptional
modestring[]Optional
Responses
201

Access grant created.

No content
post
/accessgrants
POST /accessgrants HTTP/1.1
Host: api.wallet.example.com
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "resource": "text",
  "accessRequestUri": "text",
  "expirationDate": "text",
  "forPurpose": "text",
  "mode": [
    "text"
  ]
}
No content
PreviousInboxNextAccessprompt