Skip to main content
POST
Validate an external identity provider.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Body

JSON request with ExternalProviderName. No default, required, format, or supported-name list is declared.

External sign-in provider name to check for acceptance.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.User.ApiValidateCognitoExternalProviderRequest, Derivitec.Web.Core
external_provider_name
string | null

External sign-in provider name to check; the contract declares no required format, enumeration, or default.

Response

Returns whether the external identity provider is accepted, without additional result data.

Whether the submitted external sign-in provider name is accepted.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.User.ApiValidateCognitoExternalProviderResponse, Derivitec.Web.Core
is_success
boolean

Whether the operation completed successfully. The default is true; error outcomes set it to false.

Example:

true

error_messages
string[] | null

Messages explaining operation-level failures. The collection is empty by default.