screeps-api
    Preparing search index...

    Interface AuthQueryTokenResult

    Information about an API auth token from a AuthQueryTokenResponse

    interface AuthQueryTokenResult {
        description?: string;
        endpoints?: string[];
        full: boolean;
        token: string;
        websockets?: string[];
    }
    Index

    Properties

    description? endpoints? full token websockets?

    Properties

    description?: string

    The name/description that was provided with the key generation request

    endpoints?: string[]

    List of permitted REST API endpoints (ex: GET /api/user/name)

    full: boolean

    If true, this token can be used to authenticate to all API endpoints. If false, endpoints and websockets will be defined.

    token: string

    The API auth token supplied with the request

    websockets?: string[]

    List of permitted WebSocket API event paths (ex: WebSockets (console))

    Settings

    Member Visibility

    On This Page

    Properties