Skip to content
Connect an agent

Connections

Check whether an app's sign-in link can still be answered

open (with the app, the scopes and where the code goes), used, expired or invalid.

GET/user/apps/request

TL;DR

QuestionAnswer
What does it do?Check whether an app's sign-in link can still be answered.
What does it take?request in the query string.
What does it return?Status 200 with a body of type AppRequestState.
What can go wrong?400 no request was sent; 401 not signed in; 429 too many requests; 503 sign in with Plotwork is not available on this server (oauth.unavailable). Every failure uses the one error envelope.

What it does

open (with the app, the scopes and where the code goes), used, expired or invalid. The approval checks again.

Query parameters

FieldTypeRequiredDescription
requeststringyesThe signed authorization request, exactly as the API put it in the consent page address.

Responses

StatusMeaningBody
200What the link is now.AppRequestState
400No request was sent.ErrorResponse
401Not signed in.ErrorResponse
429Too many requests.ErrorResponse
503Sign in with Plotwork is not available on this server (oauth.unavailable).ErrorResponse

Response body

A 200 answer has the type AppRequestState.

FieldTypeRequiredDescription
state"open" | "used" | "expired" | "invalid"yes
expiresIninteger | nullyesSeconds left for an open link.
appobject | nullyes
app.idstringyesThe app's id, which is its OAuth client_id.
app.namestringyesA claim, not a fact.
app.homepagestring | nullyes
app.organisationobject | nullyesThe organisation that registered the app, or null for a person.
app.organisation.idstringyes
app.organisation.slugstringyes
app.organisation.namestringyes
app.membersOnlybooleanyes
scopesarray | nullyes
redirectUristring | nullyesWhere the app receives its code. Show its host.

See also

DocWhy
API referenceEvery endpoint, and the error envelope
SchemasEvery request and response type
Tool referenceThe operations as callable tools