Update SAML auth settings
POST /api/admin/auth/saml/settings
Updates the settings for SAML Authentication
Request
- application/json
Body
required
samlSettingsSchema
- MOD1
- MOD2
- enabled boolean
Possible values: [
true]Whether to enable or disable SAML 2.0 for this instance
- entityId string required
The SAML 2.0 entity ID
- signOnUrl string required
Which URL to use for Single Sign On
- certificate string required
The X509 certificate used to validate requests
- signOutUrl string
Which URL to use for Single Sign Out
- spCertificate string
Signing certificate for sign out requests
- autoCreate boolean
Should Unleash create users based on the emails coming back in the authentication reply from the SAML server
- emailDomains string
A comma separated list of email domains that Unleash will auto create user accounts for.
- defaultRootRole string
Possible values: [
Viewer,Editor,Admin]Assign this root role to auto created users
- defaultRootRoleId number
Assign this root role to auto created users. Should be a role ID and takes precedence over
defaultRootRole. - enableGroupSyncing boolean
Should we enable group syncing. Refer to the documentation Group syncing
- groupJsonPath string
Specifies the path in the SAML token response from which to read the groups the user belongs to.
- enabled boolean
Possible values: [
false]Whether to enable or disable SAML 2.0 for this instance
- entityId string
The SAML 2.0 entity ID
- signOnUrl string
Which URL to use for Single Sign On
- certificate string
The X509 certificate used to validate requests
- signOutUrl string
Which URL to use for Single Sign Out
- spCertificate string
Signing certificate for sign out requests
- autoCreate boolean
Should Unleash create users based on the emails coming back in the authentication reply from the SAML server
- emailDomains string
A comma separated list of email domains that Unleash will auto create user accounts for.
- defaultRootRole string
Possible values: [
Viewer,Editor,Admin]Assign this root role to auto created users
- defaultRootRoleId number
Assign this root role to auto created users. Should be a role ID and takes precedence over
defaultRootRole. - enableGroupSyncing boolean
Should we enable group syncing. Refer to the documentation Group syncing
- groupJsonPath string
Specifies the path in the SAML token response from which to read the groups the user belongs to.
- 200
- 400
- 401
- 403
- 415
samlSettingsSchema
- application/json
- Schema
Schema
- MOD1
- MOD2
- enabled boolean
Possible values: [
true]Whether to enable or disable SAML 2.0 for this instance
- entityId string required
The SAML 2.0 entity ID
- signOnUrl string required
Which URL to use for Single Sign On
- certificate string required
The X509 certificate used to validate requests
- signOutUrl string
Which URL to use for Single Sign Out
- spCertificate string
Signing certificate for sign out requests
- autoCreate boolean
Should Unleash create users based on the emails coming back in the authentication reply from the SAML server
- emailDomains string
A comma separated list of email domains that Unleash will auto create user accounts for.
- defaultRootRole string
Possible values: [
Viewer,Editor,Admin]Assign this root role to auto created users
- defaultRootRoleId number
Assign this root role to auto created users. Should be a role ID and takes precedence over
defaultRootRole. - enableGroupSyncing boolean
Should we enable group syncing. Refer to the documentation Group syncing
- groupJsonPath string
Specifies the path in the SAML token response from which to read the groups the user belongs to.
- enabled boolean
Possible values: [
false]Whether to enable or disable SAML 2.0 for this instance
- entityId string
The SAML 2.0 entity ID
- signOnUrl string
Which URL to use for Single Sign On
- certificate string
The X509 certificate used to validate requests
- signOutUrl string
Which URL to use for Single Sign Out
- spCertificate string
Signing certificate for sign out requests
- autoCreate boolean
Should Unleash create users based on the emails coming back in the authentication reply from the SAML server
- emailDomains string
A comma separated list of email domains that Unleash will auto create user accounts for.
- defaultRootRole string
Possible values: [
Viewer,Editor,Admin]Assign this root role to auto created users
- defaultRootRoleId number
Assign this root role to auto created users. Should be a role ID and takes precedence over
defaultRootRole. - enableGroupSyncing boolean
Should we enable group syncing. Refer to the documentation Group syncing
- groupJsonPath string
Specifies the path in the SAML token response from which to read the groups the user belongs to.
The request data does not match what we expect.
- application/json
- Schema
- Example (from schema)
Schema
- id string
The ID of the error instance
- name string
The name of the error kind
- message string
A description of what went wrong.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "ValidationError",
"message": "The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent []."
}
Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.
- application/json
- Schema
- Example (from schema)
Schema
- id string
The ID of the error instance
- name string
The name of the error kind
- message string
A description of what went wrong.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "AuthenticationRequired",
"message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}
The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation
- application/json
- Schema
- Example (from schema)
Schema
- id string
The ID of the error instance
- name string
The name of the error kind
- message string
A description of what went wrong.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "NoAccessError",
"message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}
The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.
- application/json
- Schema
- Example (from schema)
Schema
- id string
The ID of the error instance
- name string
The name of the error kind
- message string
A description of what went wrong.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "ContentTypeerror",
"message": "We do not accept the content-type you provided (application/xml). Try using one of the content-types we do accept instead (application/json) and make sure the body is in the corresponding format."
}