Type alias generateUserApiKeyParams

generateUserApiKeyParams: {
    application_name?: string;
    auth_redirect?: string;
    client_id?: string;
    public_key?: string;
    push_url?: string;
    scopes?: string;
}

Type declaration

  • Optional application_name?: string

    the name of the application making the request (will be displayed in the user account’s Apps tab)

    Default Value

    "NodeDiscourseApi"

  • Optional auth_redirect?: string

    url to redirect back to with the generated token

  • Optional client_id?: string

    a unique identifier for the client

    Default Value

    "NodeDiscourseApi"

  • Optional public_key?: string

    the public part of the keypair generated by the client

  • Optional push_url?: string

    url to push notifications to (required and valid only if push or notifications are included in the scopes)

  • Optional scopes?: string

    comma-separated list of access scopes allowed for the key, see allow user api key scopes for the full list of available scopes

    Default Value

    "read"

Settings

Member Visibility

Theme

Generated using TypeDoc