KysoqlAPI referenceType Aliases
FirstPartyAuthorizationChallenge
Generated API reference for FirstPartyAuthorizationChallenge in @kysoql/auth.
@kysoql/auth / FirstPartyAuthorizationChallenge
type FirstPartyAuthorizationChallenge =
| {
kind: "authorized";
authorizationCode: string;
}
| {
kind: "challenge";
status: number;
error: string;
errorCode?: string;
authSession: string;
response: Readonly<Record<string, unknown>>;
};Result of a first-party Salesforce authorization challenge request.
Union Members
Type Literal
{
kind: "authorized";
authorizationCode: string;
}| Name | Type | Description |
|---|---|---|
kind | "authorized" | Indicates that Salesforce returned an authorization code. |
authorizationCode | string | Authorization code to exchange at the token endpoint. |
Type Literal
{
kind: "challenge";
status: number;
error: string;
errorCode?: string;
authSession: string;
response: Readonly<Record<string, unknown>>;
}| Name | Type | Description |
|---|---|---|
kind | "challenge" | Indicates that Salesforce requires another authorization step. |
status | number | HTTP status returned for the challenge response. |
error | string | Salesforce OAuth error identifier for the challenge. |
errorCode? | string | More specific Salesforce error code, when supplied. |
authSession | string | Session token to send when continuing the challenge flow. |
response | Readonly<Record<string, unknown>> | Flow-specific response fields such as login_status. |