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

{
    "paths": {
        "/api/v1/users/me": {
            "get": {
                "tags": [
                    "Users"
                ],
                "summary": "Get current user information",
                "description": "View information about the current user",
                "operationId": "Users_GetCurrentUser",
                "responses": {
                    "200": {
                        "description": "Information about the current user",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ApplicationUserData"
                                }
                            }
                        }
                    }
                },
                "security": [
                    {
                        "API Key": [
                            "btcpay.user.canviewprofile"
                        ],
                        "Basic": []
                    }
                ]
            },
            "delete": {
                "tags": [
                    "Users"
                ],
                "summary": "Deletes user profile",
                "description": "Deletes user profile and associated user data for user making the request",
                "operationId": "Users_DeleteCurrentUser",
                "responses": {
                    "200": {
                        "description": "User and associated data deleted successfully"
                    }
                },
                "security": [
                    {
                        "API Key": [
                            "btcpay.user.candeleteuser"
                        ],
                        "Basic": []
                    }
                ]
            }
        },
        "/api/v1/users": {
            "post": {
                "tags": [
                    "Users"
                ],
                "summary": "Create user",
                "description": "Create a new user.\n\nThis operation can be called without authentication in any of this cases:\n* There is not any administrator yet on the server,\n* The subscriptions are not disabled in the server's policies.\n\nIf the first administrator is created by this call, subscriptions are automatically disabled.",
                "requestBody": {
                    "x-name": "request",
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "additionalProperties": false,
                                "properties": {
                                    "email": {
                                        "type": "string",
                                        "description": "The email of the new user",
                                        "nullable": false
                                    },
                                    "password": {
                                        "type": "string",
                                        "description": "The password of the new user"
                                    },
                                    "isAdministrator": {
                                        "type": "boolean",
                                        "description": "Make this user administrator (only if you have the `unrestricted` permission of a server administrator)",
                                        "nullable": true,
                                        "default": false
                                    }
                                }
                            }
                        }
                    },
                    "required": true,
                    "x-position": 1
                },
                "responses": {
                    "201": {
                        "description": "Information about the new user",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ApplicationUserData"
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "A list of errors that occurred when creating the user",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ValidationProblemDetails"
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "If you need to authenticate for this endpoint (ie. the server settings policies lock subscriptions and that an admin already exists)"
                    },
                    "403": {
                        "description": "If you are authenticated but forbidden to create a new user (ie. you don't have the `unrestricted` permission on a server administrator or if you are not administrator and registrations are disabled in the server's policies)"
                    },
                    "429": {
                        "description": "DDoS protection if you are creating more than 2 accounts every minutes (non-admin only)"
                    }
                },
                "security": [
                    {
                        "API Key": [
                            "btcpay.server.cancreateuser"
                        ],
                        "Basic": []
                    }
                ]
            }
        },
        "/api/v1/users/{userId}": {
            "delete": {
                "tags": [
                    "Users"
                ],
                "summary": "Delete user",
                "description": "Delete a user.\n\nMust be an admin to perform this operation.\n\nAttempting to delete the only admin user will not succeed.\n\nAll data associated with the user will be deleted as well if the operation succeeds.",
                "parameters": [
                    {
                        "name": "userId",
                        "in": "path",
                        "required": true,
                        "description": "The ID of the user to be deleted",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "User has been successfully deleted"
                    },
                    "401": {
                        "description": "Missing authorization for deleting the user"
                    },
                    "403": {
                        "description": "Authorized but forbidden to delete the user. Can happen if you attempt to delete the only admin user."
                    },
                    "404": {
                        "description": "User with provided ID was not found"
                    }
                },
                "security": []
            }
        }
    },
    "components": {
        "schemas": {
            "ApplicationUserData": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                    "id": {
                        "type": "string",
                        "description": "The id of the user",
                        "nullable": false
                    },
                    "email": {
                        "type": "string",
                        "description": "The email of the user",
                        "nullable": false
                    },
                    "emailConfirmed": {
                        "type": "boolean",
                        "description": "True if the email has been confirmed by the user"
                    },
                    "requiresEmailConfirmation": {
                        "type": "boolean",
                        "description": "True if the email requires email confirmation to log in"
                    },
                    "created": {
                        "nullable": true,
                        "description": "The creation date of the user as a unix timestamp. Null if created before v1.0.5.6",
                        "allOf": [ {"$ref": "#/components/schemas/UnixTimestamp"}]
                    },
                    "roles": {
                        "type": "array",
                        "nullable": false,
                        "items": {
                            "type": "string"
                        },
                        "description": "The roles of the user"
                    }
                }
            }
        }
    },
    "tags": [
        {
            "name": "Users"
        }
    ]
}