OAuth Flow

OAuth implicit code flow

Send the user you want to authenticate to your registered redirect URI.
An authorization page will ask the user to sign up or log into Brime and allow the user to choose whether to authorize your application/identity system.

Create a login button with the formatted URL based on your client ID

<a href="">login</a>

📘

Refresh Tokens

Be sure to include offline_access in your scope= in order to receive a refresh token.

https://auth.brime.tv/authorize
    ?client_id=<your client ID>
    &redirect_uri=<your registered redirect URI>
    &response_type=<type>
    &scope=<space-separated list of scopes>

There are several required and optional query-string parameters:

Required ParameterTypeDescription
client_id stringYour client ID.
redirect_uri URIYour registered redirect URI. This must exactly match the redirect URI registered in the prior, Registration step.
response_type stringSpecifies what information to return. This must be token, to return an access token. The user may be prompted to confirm authorization once or repeatedly; this is controlled by the optional force_verify parameter, below.
scope stringSpace-separated list of scopes.
Optional ParameterTypeDescription
state stringYour unique token, generated by your application. This is an OAuth 2.0 opaque value, used to avoid CSRF attacks. This value is echoed back in the response. We strongly recommend you use this.