Redirect to Login
GET {Client Portal Hostname}/login
Query Parameters
| Key | Type | Required | Rule | Description |
|---|---|---|---|---|
| client_id | string | Mandatory | Client ID of the OAuth Application | |
| scope | string | Mandatory | must be user-portal:user:* | OAuth Scope |
| response_type | string | Mandatory | must be code | OAuth 2.0 response type |
| code_challenge_method | string | Mandatory | must be S256 | PKCE challenge method |
| code_challenge | string | Mandatory | refer to this guide | PKCE challenge derived from the original code_verifier |
| redirect_uri | string | Mandatory | must match registered | Redirect URI to receive the authorization code |
| state | string | Optional | CSRF protection; echoed back on redirect |
Expected Outcome
Redirects the user to the CRM login UI. After successful authentication and consent, the user is redirected to the registered redirect_uri with code and optional state as query parameters.
Error
Redirect to the registered redirect_uri with error and optional error_description as query parameters.
| error | error_description |
|---|---|
invalid_request | invalid client id |
invalid_request | invalid redirect uri |
invalid_request | invalid code challenge |
invalid_request | invalid code challenge method |
unsupported_response_type | unsupported response type |
unauthorized_client | unauthorized client |