KerberosConfigResource

REST end point for manipulating Kerberos and SSO configuration.

The following resources are part of this group:

/security/kerberos/canEnableSso

Mount Point: /api/security/kerberos/canEnableSso

GET

This end point allows applications to determine whether single-sign-on with Kerberos can be enabled or not. Single-sign-on may only be enabled if the Kerberos key distribution centre configuration is valid.

Response Body

element: (custom)
media types: text/plain

this end point simply returns a boolean value in plain text, "true" or "false"

Status Codes

code description
200 Ok
401 Authentication required
403 Authorization required - access forbidden
500 Internal server error

/security/kerberos/configuration

Mount Point: /api/security/kerberos/configuration

GET

This end point returns the current Kerberos key distribution centre configuration.

Response Body

element: kerberosConfig
media types: application/xml
application/json

this end point returns a single Kerberos configuration element

Status Codes

code description
200 Ok
401 Authentication required
403 Authorization required - access forbidden
500 Internal server error

PUT

This end point updates the current Kerberos key distribution centre configuration with the values in the given Kerberos configuration element.

Request Body

element: kerberosConfig
media types: application/xml
application/json

this end point expects a single Kerberos configuration element containing the new configuration

Response Body

element: kerberosConfig
media types: application/xml
application/json

this end point returns a single Kerberos configuration element containing the newly updated configuration

Status Codes

code description
200 Ok
400 The given Kerberos configuration is invalid
401 Authentication required
403 Authorization required - access forbidden
500 Internal server error

/security/kerberos/enableSso

Mount Point: /api/security/kerberos/enableSso

POST

This end point allows an application to enable or disable single-sign-on with Kerberos. If enabled, user-agents will be prompted for SPNEGO authentication instead of showing the standard HTML log in form.

Parameters

name description type default
enable set this parameter to "true" to enable single-sign-on, "false" to disable single-sign-on form

Status Codes

code description
200 Ok
400 The given Kerberos configuration is invalid
401 Authentication required
403 Authorization required - access forbidden
500 Internal server error

/security/kerberos/isSsoEnabled

Mount Point: /api/security/kerberos/isSsoEnabled

GET

This end point allows applications to determine whether single-sign-on with Kerberos is enabled or not. If enabled, user-agents will be prompted for SPNEGO authentication instead of showing the standard HTML log in form.

Response Body

element: (custom)
media types: text/plain

this end point simply returns a boolean value in plain text, "true" or "false"

Status Codes

code description
200 Ok
401 Authentication required
403 Authorization required - access forbidden
500 Internal server error