Skip to main content

HandleCallbackDTO

Package: @nauth-toolkit/core Type: DTO (Request)

OAuth callback request containing authorization code and CSRF state parameter.

import { HandleCallbackDTO } from '@nauth-toolkit/nestjs';

Properties

PropertyTypeRequiredDescription
codestringYesAuthorization code from OAuth callback. Max 2000 characters. Trimmed.
statestringYesCSRF state parameter from OAuth callback. Max 500 characters. Trimmed.
profileDataRecord<string, unknown>NoOptional profile data from OAuth callback. Used by providers like Apple that send user data directly in the callback (first sign-in only).

Example

{
"code": "4/0AQlEd8y...",
"state": "random-csrf-state-123"
}

Apple callback with profile data (first sign-in only):

{
"code": "abc123...",
"state": "csrf-state-xyz",
"profileData": {
"name": { "firstName": "John", "lastName": "Doe" },
"email": "user@privaterelay.appleid.com"
}
}

Used By

  • BaseSocialAuthProviderService.handleCallback() - Internal provider method
  • BaseSocialAuthProviderService.getUserProfileFromCallback() - Internal provider method