ExternalAuth #
Package : spaceone.api.identity.v2
ExternalAuth #
ExternalAuth Methods:
| Method | Request | Response |
|---|---|---|
| set | SetExternalAuthRequest | ExternalAuthInfo |
| unset | ExternalAuthRequest | ExternalAuthInfo |
| get | ExternalAuthRequest | ExternalAuthInfo |
set #
Google OAuth2, Keycloak OIDC, SAML are supported as external authentication.
POST /identity/v2/external-auth/set
- plugin_info (PluginRequest)
Required
{
"plugin_id": "plugin-googleoauth2-identity-auth",
"upgrade_mode": "AUTO",
"options": {
"client_id": "client_id",
"protocol": "oauth2",
"identity_provider": "google",
"validator": "gmail.com"
}
}domain_id (string)
Requiredstate (State)
Requiredplugin_info (PluginInfo)
Requiredupdated_at (string)
Required
{
"domain_id": "domain-123456",
"plugin_info": {
"metadata": {
"authorization_endpoint": "https://www.googleapis.com",
"client_id": "client_id",
"identity_provider": "google",
"protocol": "oauth2",
"token_endpoint": "https://www.googleapis.com/oauth2/v2/tokeninfo",
"userinfo_endpoint": "https://www.googleapis.com/oauth2/v3/userinfo",
"validator": "gmail.com"
},
"options": {
"client_id": "client_id",
"identity_provider": "google",
"protocol": "oauth2",
"validator": "gmail.com"
},
"plugin_id": "plugin-googleoauth2-identity-auth",
"upgrade_mode": "AUTO",
"version": "1.1.3"
}
}unset #
Unset external authentication information.
POST /identity/v2/external-auth/unset
domain_id (string)
Requiredstate (State)
Requiredplugin_info (PluginInfo)
Requiredupdated_at (string)
Required
{
"domain_id": "domain-123456",
"plugin_info": {
"metadata": {
"authorization_endpoint": "https://www.googleapis.com",
"client_id": "client_id",
"identity_provider": "google",
"protocol": "oauth2",
"token_endpoint": "https://www.googleapis.com/oauth2/v2/tokeninfo",
"userinfo_endpoint": "https://www.googleapis.com/oauth2/v3/userinfo",
"validator": "gmail.com"
},
"options": {
"client_id": "client_id",
"identity_provider": "google",
"protocol": "oauth2",
"validator": "gmail.com"
},
"plugin_id": "plugin-googleoauth2-identity-auth",
"upgrade_mode": "AUTO",
"version": "1.1.3"
}
}get #
Get external authentication information.
POST /identity/v2/external-auth/get
domain_id (string)
Requiredstate (State)
Requiredplugin_info (PluginInfo)
Requiredupdated_at (string)
Required
{
"domain_id": "domain-123456",
"plugin_info": {
"metadata": {
"authorization_endpoint": "https://www.googleapis.com",
"client_id": "client_id",
"identity_provider": "google",
"protocol": "oauth2",
"token_endpoint": "https://www.googleapis.com/oauth2/v2/tokeninfo",
"userinfo_endpoint": "https://www.googleapis.com/oauth2/v3/userinfo",
"validator": "gmail.com"
},
"options": {
"client_id": "client_id",
"identity_provider": "google",
"protocol": "oauth2",
"validator": "gmail.com"
},
"plugin_id": "plugin-googleoauth2-identity-auth",
"upgrade_mode": "AUTO",
"version": "1.1.3"
}
}Message #
ExternalAuthInfo #
domain_id (string)
Requiredstate (State)
Requiredplugin_info (PluginInfo)
Requiredupdated_at (string)
Required
ExternalAuthRequest
#
SetExternalAuthRequest #
plugin_info (PluginRequest)
Required