btcpayserver/BTCPayServer/wwwroot/swagger/v1/swagger.template.authorization.json

{
    "paths": {
        "/api-keys/authorize": {
            "get": {
                "tags": [
                    "Authorization"
                ],
                "summary": "Authorize User",
                "description": "Redirect the browser to this endpoint to request the user to generate an api-key with specific permissions",
                "parameters": [
                    {
                        "name": "permissions",
                        "description": "The permissions to request. (See API Key authentication)",
                        "in": "query",
                        "style": "form",
                        "explode": true,
                        "schema": {
                            "type": "array",
                            "nullable": true,
                            "items": {
                                "type": "string"
                            }
                        },
                        "x-position": 1
                    },
                    {
                        "name": "applicationName",
                        "description": "The name of your application",
                        "in": "query",
                        "schema": {
                            "type": "string",
                            "nullable": true
                        },
                        "x-position": 2
                    },
                    {
                        "name": "strict",
                        "description": "If permissions are specified, and strict is set to false, it will allow the user to reject some of permissions the application is requesting.",
                        "in": "query",
                        "schema": {
                            "type": "boolean",
                            "default": true,
                            "nullable": true
                        },
                        "x-position": 3
                    },
                    {
                        "name": "selectiveStores",
                        "description": "If the application is requesting the CanModifyStoreSettings permission and selectiveStores is set to true, this allows the user to only grant permissions to selected stores under the user's control.",
                        "in": "query",
                        "schema": {
                            "type": "boolean",
                            "default": false,
                            "nullable": true
                        },
                        "x-position": 4
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A HTML form that a user can use to confirm permissions to grant",
                        "content": {
                            "text/html": {
                            }
                        }
                    }
                },
                "security": []
            }
        }
    }
}