"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
},
"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
},
"x-position":4
}
],
"responses":{
"200":{
"description":"",
"content":{
"application/octet-stream":{
"schema":{
"type":"string",
"format":"binary"
}
}
}
}
},
"security":[
{
"APIKey":[]
}
]
}
},
"/api/v1/users/me":{
"get":{
"tags":[
"Users"
],
"summary":"Get current user information",
"description":"View information about the current user",
"description":"BTCPay Server supports authenticating and authorizing users through an API Key that is generated by them. Send the API Key as a header value to Authorization with the format: token {token}. For a smoother experience, you can generate a url that redirects users to an API key creation screen.\n\n The following permissions applies to the context of the user creating the API Key:\n * `unrestricted`: Allow unrestricted access to your account.\n * `btcpay.server.canmodifyserversettings`: Allow total control on the server settings. (only if user is administrator)\n * `btcpay.server.cancreateuser`: Allow the creation new users on this server. (only if user is administrator)\n * `btcpay.user.canviewprofile`: Allow view access to your user profile.\n * `btcpay.user.canmodifyprofile`: Allow view and modification access to your user profile.\n\nThe following permissions applies to all stores of the user, you can limit to a specific store with the following format: `btcpay.store.cancreateinvoice:6HSHAEU4iYWtjxtyRs9KyPjM9GAQp8kw2T9VWbGG1FnZ`:\n * `btcpay.store.canviewstoresettings`: Allow view access to the stores settings. \n * `btcpay.store.canmodifystoresettings`: Allow view and modification access to the stores settings.\n * `btcpay.store.cancreateinvoice`: Allow invoice creation of the store.\n\nNote that API Keys only limits permission of a user and can never expand it. If an API Key has the permission `btcpay.server.canmodifyserversettings` but that the user account creating this API Key is not administrator, the API Key will not be able to modify the server settings.\n",
