Skip to main content
zerotal

Documentation

Documentation / @zerotal/auth / AppleOAuth2Config

Interface: AppleOAuth2Config

Defined in: auth/src/social/types.ts:62

Apple-specific config. Supply either clientSecret (a pre-signed JWT) or the three raw Apple credentials — the driver will sign the JWT automatically using the Web Crypto API (no external dependency needed).

Extends

Properties

clientId

clientId: string

Defined in: auth/src/social/types.ts:48

OAuth2 client / application ID issued by the provider.

Inherited from

OAuth2Config.clientId

clientSecret?

optional clientSecret?: string

Defined in: auth/src/social/types.ts:50

Static client secret, or omit for Apple and supply teamId/keyId/privateKey instead.

Inherited from

OAuth2Config.clientSecret

redirectUrl

redirectUrl: string

Defined in: auth/src/social/types.ts:52

Fixed callback URL, matching the one registered with the provider.

Inherited from

OAuth2Config.redirectUrl

scopes?

optional scopes?: string[]

Defined in: auth/src/social/types.ts:54

Scopes to request; when omitted the driver's defaultScopes() are used.

Inherited from

OAuth2Config.scopes

teamId?

optional teamId?: string

Defined in: auth/src/social/types.ts:64

Your Apple Developer Team ID (10-character string).

keyId?

optional keyId?: string

Defined in: auth/src/social/types.ts:66

The Key ID of the private key created in App Store Connect.

privateKey?

optional privateKey?: string

Defined in: auth/src/social/types.ts:71

PEM-encoded PKCS#8 ES256 private key downloaded from App Store Connect. Include the full -----BEGIN PRIVATE KEY----- / -----END PRIVATE KEY----- block.