Skip to content
Authrim

Update SAML settings.

PUT
/api/admin/saml-settings
Code sample: Shell / cURL 
curl --request PUT \
  --url https://auth.example.com/api/admin/saml-settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "entityIdStyle": "tenant_path", "interactiveLoginUrlPolicy": "tenant_login_url" }'

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
entityIdStyle
string
Allowed values: legacy tenant_path tenant_subdomain
interactiveLoginUrlPolicy
string
certificateSubject
object
key
additional properties
certificateSubjectAlternativeNames
Array<string>
Example 
{
  "entityIdStyle": "tenant_path",
  "interactiveLoginUrlPolicy": "tenant_login_url"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful JSON response.

Media type application/json
object
tenantId
required
string
entityIdStyle
required
string
interactiveLoginUrlPolicy
required
string
certificateSubject
object
key
additional properties
certificateSubjectAlternativeNames
Array<string>
signingKeyPolicies
object
key
additional properties
metadata
required
object
key
additional properties
localSigning
required
object
key
additional properties
generated
required
object
issuerUrl
required
string format: uri
idpEntityId
required
string
spEntityId
required
string
idpMetadataUrl
required
string format: uri
spMetadataUrl
required
string format: uri
key
additional properties
Example 
{
  "tenantId": "tenant_123",
  "entityIdStyle": "tenant_path",
  "interactiveLoginUrlPolicy": "tenant_login_url",
  "certificateSubject": {
    "commonName": "Authrim SAML"
  },
  "certificateSubjectAlternativeNames": [],
  "signingKeyPolicies": {},
  "metadata": {
    "publicationEnabled": true
  },
  "localSigning": {
    "certificateSubject": {
      "commonName": "Authrim SAML"
    },
    "certificateSubjectAlternativeNames": [],
    "idpSigningKeyPolicy": {},
    "spSigningKeyPolicy": {}
  },
  "generated": {
    "issuerUrl": "https://auth.example.com",
    "idpEntityId": "https://auth.example.com/saml/idp/metadata",
    "spEntityId": "https://auth.example.com/saml/sp/metadata",
    "idpMetadataUrl": "https://auth.example.com/saml/idp/metadata",
    "spMetadataUrl": "https://auth.example.com/saml/sp/metadata"
  }
}