跳到主要内容

AuthServiceDto

One third-party authorization or storage provider and the keys the portal connects to it with.

NameTypeDescriptionNotes
nameStringThe internal key of the provider, such as google or box. It is the name that POST api/2.0/settings/authservice takes to select the provider.[optional] [example: google] [nullable]
titleStringThe provider name as it is shown in the interface.[optional] [example: Google] [nullable]
descriptionStringA sentence about what connecting the provider gives the portal, shown next to it in the interface.[optional] [example: Google OAuth authentication] [nullable]
instructionStringThe steps an administrator has to take on the provider side to obtain the keys, shown in the interface.[optional] [example: Configure your Google OAuth credentials] [nullable]
canSetBooleanWhether this provider accepts keys through the API at all. A provider whose keys are fixed by the installation reports false, and saving keys for it is refused.[optional] [example: true]
paidBooleanWhether the provider is a paid option. A paid one can only be connected while the portal plan includes third-party storage or the installation is licensed as self-hosted.[optional] [example: false]
propsListThe keys the provider defines, with the values last saved and how the settings form shows each of them. It is null for a provider that forbids changes (canSet is false): its keys are not read at all.[optional] [example: [{name=googleClientId, value=1234567890-abc.apps.googleusercontent.com, title=Client ID, type=text}]] [nullable]