OpenClaw SDK
    Preparing search index...

    Interface CredentialsProvider

    Credentials provider interface for secure credential access.

    interface CredentialsProvider {
        getToken?(): Promise<string | null>;
        refreshToken?(currentToken: string | null): Promise<RefreshResult>;
        getDeviceCredentials?(): Promise<DeviceCredentials | null>;
        getBootstrapToken?(): Promise<string | null>;
        getPassword?(): Promise<{ username: string; password: string } | null>;
        signChallenge?(nonce: string, timestamp: number): Promise<string>;
    }

    Implemented by

    Index

    Methods

    getToken? refreshToken? getDeviceCredentials? getBootstrapToken? getPassword? signChallenge?

    Methods

    • Get authentication token.

      Returns Promise<string | null>

    • Refresh authentication token. Called before reconnection if token might be expired.

      Parameters

      • currentToken: string | null

      Returns Promise<RefreshResult>

    • Get bootstrap token for initial pairing.

      Returns Promise<string | null>

    • Get password credentials.

      Returns Promise<{ username: string; password: string } | null>

    • Sign a challenge nonce. Required for device auth.

      Parameters

      • nonce: string
      • timestamp: number

      Returns Promise<string>

    Settings

    Member Visibility

    On This Page

    Methods