SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias CredentialsAuthRequest

    CredentialsAuthRequest: Message<"soulfire.v1.CredentialsAuthRequest"> & {
        instanceId: string;
        payload: string[];
        service: AccountTypeCredentials;
    }

    Request message for credentials-based Minecraft account authentication. Supports bulk authentication of multiple accounts in a single request.

    Type Declaration

    • instanceId: string

      The UUID of the SoulFire instance to authenticate accounts for. Must be a valid UUID string. The instance must exist and the caller must have AUTHENTICATE_MC_ACCOUNT permission for this instance.

      from field: string instance_id = 1;

    • payload: string[]

      List of authentication credentials/data strings. Each string is processed according to the service type. Multiple payloads are authenticated concurrently (controlled by ACCOUNT_IMPORT_CONCURRENCY instance setting).

      from field: repeated string payload = 3;

    • service: AccountTypeCredentials

      The authentication service type to use. Determines how the payload strings are interpreted:

      • MICROSOFT_JAVA_CREDENTIALS: Payload format is "email:password"
      • MICROSOFT_BEDROCK_CREDENTIALS: Payload format is "email:password"
      • OFFLINE: Payload is the username to use (no authentication performed)
      • MICROSOFT_JAVA_REFRESH_TOKEN: Payload is a Microsoft refresh token
      • THE_ALTENING: Payload is a TheAltening account token

      from field: soulfire.v1.AccountTypeCredentials service = 2;

    from message soulfire.v1.CredentialsAuthRequest