Auth

View on Githubarrow-up-right

circle-exclamation
Package
Version
Downloads

This package contains some OAuth utilities for implementing authentication and authorization against the CARTO 2 platform. If you are building an application with CARTO 3, you should use Auth0 React SDKarrow-up-right instead of this package.

Components

OAuthCallback

React component to attend OAuth callbacks on /oauthCallback. Ensure you include that specific route in your application.

  • Example:

import { OAuthCallback } from "@carto/react-auth";

// inside the proper routing config...
const routes = [
  /* ...some other routes and */
  { path: "/oauthCallback", element: <OAuthCallback /> },
];

Functions

useOAuthLogin

Hook to perform login against CARTO, with OAuth implicit flow and using a popup.

  • Input:

Param
Type
Description

oauthApp

Object

OAuth parameters

oauthApp.clientId

string

Application client ID

oauthApp.scopes

Array.<string>

Scopes to request

oauthApp.authorizeEndPoint

string

Authorization endpoint

onParamsRefreshed

function

Function to call when params are refreshed

  • Returns: function - A function to trigger oauth with a popup

  • Example:

Tip: Check CARTO for React templates for CARTO 2 for examples using this hook, where oauthApp data is managed within Redux store. For example, this is the Login pagearrow-up-right.

Last updated

Was this helpful?