End the current session.
const url = 'https://api.opdns.io/v1/auth/logout';const options = { method: 'POST', headers: {cookie: '__Host-opdns_session=<__Host-opdns_session>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.opdns.io/v1/auth/logout \ --cookie __Host-opdns_session=<__Host-opdns_session>Deletes the calling session, records auth.logout in the audit log and
clears the session cookie, then answers where the browser goes next:
opauth’s end_session endpoint (with the session’s ID token as
id_token_hint and the dashboard as post_logout_redirect_uri), so the
op account signs out too; the dashboard navigates there. Session cookie
only.
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”Logged out; the cookie is cleared.
object
Where to navigate to finish signing out.
Example
{ "redirect_url": "https://opauth.net/end_session?client_id=opdns"}Not authenticated.
object
Stable machine code.
object
Seconds, repeating the Retry-After header (rate limits, offline nodes).
The plan limit a plan_limit problem hit.
object
The plan’s value of the limit.
Where to move to a larger plan.
The scope the API token lacked (insufficient_scope).
Example
{ "type": "https://opdns.io/problems/unauthenticated", "title": "Unauthorized", "status": 401, "code": "unauthenticated", "detail": "You're not signed in, or your sign-in has ended. Please sign in again to continue.", "request_id": "5f2c9a0e7b1d4c38"}Authenticated but not allowed: insufficient_scope, session_required, csrf_rejected, reauth_required (sign in again within five minutes), account_pending_deletion (the account is in its deletion cooling-off), email_unverified (creating a profile before the email address is verified).
object
Stable machine code.
object
Seconds, repeating the Retry-After header (rate limits, offline nodes).
The plan limit a plan_limit problem hit.
object
The plan’s value of the limit.
Where to move to a larger plan.
The scope the API token lacked (insufficient_scope).
Example
{ "type": "https://opdns.io/problems/insufficient_scope", "title": "Forbidden", "status": 403, "code": "insufficient_scope", "detail": "This API token isn't allowed to do this: it needs the profiles:write scope. Create a token that includes it, then try again.", "required_scope": "profiles:write", "request_id": "5f2c9a0e7b1d4c38"}