Summary
Update a SSO configuration
Description
Update a SSO configuration
Route
PUT /sso/configs/:name
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| name |
string |
yes |
The name of the SSO configuration to delete |
| config |
object |
yes |
SSO configuration |
Copied to Clipboard
{
"config": {
"name": "Auth0",
"ssoType": "saml",
"settings": {
"issuer": "https://www.auth0.com/oauth2/example",
"loginURL": "https://www.auth0.com/login",
"certificate": "MIIDrjCCApagAwIBAgIGAYbHI140MA0GCSqGSIb3DQEBCwUAMIGXMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEU==",
"samlUserNameAttribute": "userName",
"samlGroupsAttribute": "http://schemas.microsoft.com/ws/2008/06/identity/claims/groups",
"forceLogin": false,
"description": "This sso configuration connects to Okta",
"logoutURL": "https://www.auth0.com/logout",
"samlEmailAttribute": "mail",
"samlFirstNameAttribute": "firstName"
},
"tested": false
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"config": {
"title": "config",
"$ref": "sso-schema"
}
},
"required": [
"config"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
The result of the SSO config update process. |
Copied to Clipboard
{
"status": "OK",
"message": "A sample success message",
"data": {
"name": "Auth0",
"ssoType": "saml",
"settings": {
"issuer": "https://www.auth0.com/oauth2/example",
"loginURL": "https://www.auth0.com/login",
"certificate": "MIIDrjCCApagAwIBAgIGAYbHI140MA0GCSqGSIb3DQEBCwUAMIGXMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEU==",
"samlUserNameAttribute": "username",
"samlGroupsAttribute": "http://schemas.microsoft.com/ws/2008/06/identity/claims/groups",
"forceLogin": false,
"description": "This sso configuration connects to Okta",
"logoutURL": "https://www.auth0.com/logout",
"samlEmailAttribute": "mail",
"samlFirstNameAttribute": "name"
},
"tested": true
}
}
