Table of Contents
OAuth Endpoint Reference
This page contains a list of all available OAuth related endpoints, what parameters they take and what output they may provide. If you're looking to implement the bare minimum, you'll only have to care about GET flashii.net/oauth2/authorize and POST api.flashii.net/oauth2/token.
GET api.flashii.net/.well-known/oauth-authorization-server
To learn more about discovering authorization server metadata, see oauth:discovery.
GET api.flashii.net/.well-known/oauth-protected-resource
To learn more about discovering authorization server metadata, see oauth:discovery.
POST api.flashii.net/oauth2/introspect
GET api.flashii.net/oauth2/jwks.json
POST api.flashii.net/oauth2/request-authorize
POST api.flashii.net/oauth2/revoke
POST api.flashii.net/oauth2/token
GET api.flashii.net/oauth2/userinfo
GET flashii.net/.well-known/oauth-authorization-server
To learn more about discovering authorization server metadata, see oauth:discovery.
GET flashii.net/.well-known/oauth-protected-resource
To learn more about discovering authorization server metadata, see oauth:discovery.
GET flashii.net/.well-known/openid-configuration
For more details on how to use OpenID Connect with Flashii, see oauth:openid.
GET flashii.net/.well-known/webfinger
For more details on how to use OpenID Connect with Flashii, see oauth:openid.
GET fii.moe/verify
A shorter alternative for the GET flashii.net/oauth2/verify. Used in the response body for POST api.flashii.net/oauth2/request-authorize.
GET flashii.net/oauth2/authorize
For more details on how to use the normal authorization flow, see oauth:authorize.
Page through which a user reviews an authorization request.
Request
Query parameters
response_type(required) - Response type of the token request. Must be eithercodefor normal authorization requests orcode id_tokenfor OpenID Connect authorization requests.client_id(required) - Client ID for the client/application that is making this authorization request.redirect_uri(required) if more than one URI is registered, (optional) if there's only one - Redirect URI to return to after the user has reviewed the authorization request. Must be registered. If the an unknown redirect URI is specified, the error will be rendered to the user without redirecting.scope(optional) - Scope of this authorization request.state(optional) - A state parameter that will be included in the query parameters of theredirect_urivalue. May not be longer than 1000 characters.code_challenge(required) if public client, (optional) if confidential client - PKCE code challenge, ifcode_challenge_methodisS256the value must be 43 characters long and contain a URI BASE64 encoded SHA256 HMAC hash, ifplainthe value must be be at least 43 characters and at most 128 characters.S256is recommended.code_challenge_method(optional) - Processing method for thecode_challengevalue. If specified, must be eitherplainfor passthru, orS256for HMAC SHA256. If left unspecified,plainwill be used. If specified,code_challengemust also be specified.
Response
- HTTP 200
text/html: A HTML document through which the user reviews the authorization request. If the specifiedredirect_uriis recognized, the user agent will be redirect to it with the outcome of the authorization request. In both cases thestateparameter will be passed along. If anerrorparameter is included, an additionalerror_descriptionparameter containing an English explanation of the error may be included, an additionalerror_uriparameter containing a URI to relevant documentation may also be included.- If the user approved the authorization request, the user agent will redirect to the relevant URI with the
codeparameter set to an authorization code that can be used with the authorization code token flow. Optionally, if theopenidscope was requested, anid_tokentoken containing a JWT will be included. - If the user denied the authorization request, the user agent will redirect to the relevant URI with the
errorparameter set toaccess_denied. - If a server error (HTTP 500) occurred, the user agent will redirect to the relevant URI with the
errorparameter set toserver_error. - If a public client attempted to request authorization without a PKCE
challenge_codeparameter, the user agent will redirect to the relevant URI with theerrorparameter set toinvalid_request. - If the user waited too long before pressing the Authorize button, the user agent will redirect to the relevant URI with the
errorparameter set toinvalid_request. - If the
code_challengeand/orcode_challenge_methodparameters are not set to an acceptable value, the user agent will redirect to the relevant URI with theerrorparameter set toinvalid_request. - If the
response_typeparameter is not set to an acceptable value, the user agent will redirect to the relevant URI with theerrorparameter set tounsupported_response_type. - If an unsupported scope is requested in the
scopeparameter, the user agent will redirect to the relevant URI with theerrorparameter set toinvalid_scope. Theerror_descriptionmessage will contain which requested value caused the problem.
GET flashii.net/oauth2/verify
To learn more about the device token authorization, see oauth:device-authorize.
User verification page for the device token flow.
Request
Query parameters
code(optional) - Value ofuser_codereceived in the response body of POST api.flashii.net/oauth2/request-authorize.
Response
- HTTP 200
text/html: A HTML document through which the user reviews the authorization request. The document will either confirm that that the authorization request succeeded or explain why it failed. No redirects will occur.
