@grabjs/superapp-sdk
    Preparing search index...

    Type Alias AuthorizeRequest

    Request parameters for initiating an OAuth2 authorization flow with PKCE.

    Production environment with redirect mode:

    {
      clientId: 'your-client-id',
      redirectUri: 'https://your-app.com/callback',
      scope: 'openid profile',
      environment: 'production',
      responseMode: 'redirect'
    }

    Staging environment with in_place mode:

    {
      clientId: 'staging-client-id',
      redirectUri: 'https://staging-app.com/callback',
      scope: 'openid',
      environment: 'staging',
      responseMode: 'in_place'
    }
    type AuthorizeRequest = {
        clientId: string;
        environment: "staging" | "production";
        redirectUri: string;
        responseMode?: "redirect" | "in_place";
        scope: string;
    }
    Index

    Properties

    clientId environment redirectUri responseMode? scope

    Properties

    clientId: string

    The OAuth2 client ID for your MiniApp.

    environment: "staging" | "production"

    The environment to use for authorization ('staging' or 'production').

    redirectUri: string

    The redirect URI registered for your MiniApp.

    responseMode?: "redirect" | "in_place"

    The response mode for the authorization flow.

    • 'redirect': User is redirected to the redirect URI after authorization
    • 'in_place': Authorization happens within the current page context
    'redirect'
    scope: string

    The OAuth2 scopes to request (space-separated string).

    Settings

    Member Visibility

    On This Page

    Properties