Update Docs

This commit is contained in:
Root 2023-11-04 18:26:27 +01:00
parent e9470b709e
commit 2eaab3d565

View File

@ -126,3 +126,75 @@ _Generates a new grant and returns information useful for identifying the grant_
"create": "<Unix Timestamp at creation time, Numeric>", "create": "<Unix Timestamp at creation time, Numeric>",
"result": "created" "result": "created"
} }
**Errors:**
{
"error": {
"message": "<Exception Message>" (500)
}
}
## Grant: Destroy (E)
_Deletes the identified grant from the system and invalidates all Session Tickets potentially issued in name of the Grant_
**Request:**
URL:
/api/v1/grant/destroy/<Grant ID>
Body:
{
... auth ...
"data": {}
}
**Response:**
{
"result": "destroyed"
}
**Errors:**
{
"error": {
"message": "not found" (404) //
"message": "<Exception Message>" (500)
}
}
## Grant: Status (E)
_Fetch Authorization Status of Grant and get a list of data associated with the grant, such as creation time_
**Request:**
URL:
/api/v1/grant/status/<Grant ID>
Body:
{
... auth ...
"data": {}
}
**Response:**
{
"grant": "<Generated Grant ID, Alphanumeric>",
"service": "<Requesting Service's Name, Alphanumeric>",
"create": "<Unix Timestamp at creation time, Numeric>",
"status": "created",//
"status": "approved",
-> "ticket": "<Ticket ID>",
"result": "ok"
}
**Errors:**
{
"error": {
"message": "not found" (404) //
"message": "<Exception Message>" (500)
}
}