IlyaSobolev/DocSpace-client
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

sso settings: added api descriptions

Browse Source
This commit is contained in:
Natalia Ovchinnikova 2023-03-10 18:35:46 +03:00
parent bf5ab933a9
commit 51d26ffa9d
1 changed files with 28 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
web/ASC.Web.Api/Api/Settings/SsoController.cs
View File

@ -53,8 +53,8 @@ public class SsoController : BaseSettingsController
_coreBaseSettings = coreBaseSettings;
_userManager = userManager;
_messageService = messageService;
}
}
/// <summary>
/// Returns the current portal SSO settings.
/// </summary>
@ -62,7 +62,9 @@ public class SsoController : BaseSettingsController
/// Get the SSO settings
/// </short>
/// <category>SSO</category>
/// <returns>SSO settings</returns>
/// <returns>SSO settings</returns>
/// <path>api/2.0/settings/ssov2</path>
/// <httpMethod>GET</httpMethod>
[HttpGet("ssov2")]
public SsoSettingsV2 GetSsoSettingsV2()
{
@ -76,8 +78,8 @@ public class SsoController : BaseSettingsController
}
return settings;
}
}
/// <summary>
/// Returns the default portal SSO settings.
/// </summary>
@ -85,22 +87,26 @@ public class SsoController : BaseSettingsController
/// Get the default SSO settings
/// </short>
/// <category>SSO</category>
/// <returns>Default SSO settings</returns>
/// <returns>Default SSO settings</returns>
/// <path>api/2.0/settings/ssov2/default</path>
/// <httpMethod>GET</httpMethod>
[HttpGet("ssov2/default")]
public SsoSettingsV2 GetDefaultSsoSettingsV2()
{
CheckSsoPermissions();
return _settingsManager.GetDefault<SsoSettingsV2>();
}
}
/// <summary>
/// Returns the constants of the SSO settings.
/// Returns the SSO settings constants.
/// </summary>
/// <short>
/// Get the constants of the SSO settings
/// Get the SSO settings constants
/// </short>
/// <category>SSO</category>
/// <returns>Constants of the SSO settings</returns>
/// <returns>The SSO settings constants</returns>
/// <path>api/2.0/settings/ssov2/constants</path>
/// <httpMethod>GET</httpMethod>
[HttpGet("ssov2/constants")]
public object GetSsoSettingsV2Constants()
{
@ -113,8 +119,8 @@ public class SsoController : BaseSettingsController
SsoSpCertificateActionType = new SsoSpCertificateActionType(),
SsoIdpCertificateActionType = new SsoIdpCertificateActionType()
};
}
}
/// <summary>
/// Saves the SSO settings for the current portal.
/// </summary>
@ -122,8 +128,10 @@ public class SsoController : BaseSettingsController
/// Save the SSO settings
/// </short>
/// <category>SSO</category>
/// <param name="serializeSettings">Serialized SSO settings</param>
/// <returns>SSO settings</returns>
/// <param name="model">Serialized SSO settings</param>
/// <returns>SSO settings</returns>
/// <path>api/2.0/settings/ssov2</path>
/// <httpMethod>POST</httpMethod>
[HttpPost("ssov2")]
public SsoSettingsV2 SaveSsoSettingsV2(SsoSettingsRequestsDto model)
{
@ -195,8 +203,8 @@ public class SsoController : BaseSettingsController
_messageService.Send(messageAction);
return settings;
}
}
/// <summary>
/// Resets the SSO settings of the current portal.
/// </summary>
@ -204,7 +212,9 @@ public class SsoController : BaseSettingsController
/// Reset the SSO settings
/// </short>
/// <category>SSO</category>
/// <returns>Default SSO settings</returns>
/// <returns>Default SSO settings</returns>
/// <path>api/2.0/settings/ssov2</path>
/// <httpMethod>DELETE</httpMethod>
[HttpDelete("ssov2")]
public SsoSettingsV2 ResetSsoSettingsV2()
{