Skip to main content

Retrieve an SAML service provider configuration

Contributors
PDFs

GET /security/authentication/cluster/saml-sp

Introduced In: 9.6

Retrieves a SAML service provider configuration.

Parameters

Name Type In Required Description

host

string

query

False

Filter by host

  • Introduced in: 9.7

enabled

boolean

query

False

Filter by enabled

  • Introduced in: 9.7

idp_uri

string

query

False

Filter by idp_uri

  • Introduced in: 9.7

certificate.ca

string

query

False

Filter by certificate.ca

  • Introduced in: 9.7

  • maxLength: 256

  • minLength: 1

certificate.serial_number

string

query

False

Filter by certificate.serial_number

  • Introduced in: 9.7

  • maxLength: 40

  • minLength: 1

certificate.common_name

string

query

False

Filter by certificate.common_name

  • Introduced in: 9.7

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

certificate

certificate

enabled

boolean

The SAML service provider is enabled. Valid for PATCH and GET operations only.

host

string

The SAML service provider host.

idp_uri

string

The identity provider (IdP) metadata location. Required for POST operations.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "certificate": {
    "ca": "string",
    "common_name": "cluster1",
    "serial_number": "1506B24A94F566BA"
  },
  "host": "string",
  "idp_uri": "https://idp.example.com/FederationMetadata/2007-06/FederationMetadata.xml"
}

Error

Status: Default, Error
Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

certificate

Name Type Description

ca

string

Server certificate issuing certificate authority (CA). This cannot be used with the server certificate common name.

common_name

string

Server certificate common name. This cannot be used with the certificate authority (CA) or serial_number.

serial_number

string

Server certificate serial number. This cannot be used with the server certificate common name.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.