v1

latestOpenAPI 3.0.02026-07-175652103.9 KB
login

Login Options

This is called by the client for knowing the Oauth2 provider(s) available You must provide a list of Oauth2 providers in the oauth2.toml config file The config file can be overridden by the OAUTH2_CONFIG_FILE environment variable

This function is an API endpoint that is called by the client to get the list of available OAuth2 providers. The list of providers is defined in the oauth2.toml config file, which can be overridden by the OAUTH2_CONFIG_FILE environment variable. It is tagged with "login" for OpenAPI documentation.

Limitations

It needs to be completed for mapping the username and email from the OAuth2 provider to the SCTGDesk user.

Parameters

  • none

Returns

If successful, this function returns a Json<Vec<String>> object, which includes the list of available OAuth2 providers. <br> If the config file is not found or cannot be read, this function returns a status::Unauthorized error. <br>

Errors

This function will return an error if the system is in maintenance mode, or if the config file is not found or cannot be read.

Example

GET /api/login-options

get/api/login-options

Response

string[] required