Skip to main content
REST API reference

Retrieve the SAML default metadata configuration

PDFs

GET /security/authentication/cluster/saml-sp/default-metadata

Introduced In: 9.17

Retrieves the SAML default metadata configuration.

Parameters

Name Type In Required Description

certificate.ca

string

query

False

Filter by certificate.ca

  • maxLength: 256

  • minLength: 1

certificate.common_name

string

query

False

Filter by certificate.common_name

certificate.serial_number

string

query

False

Filter by certificate.serial_number

  • maxLength: 40

  • minLength: 1

scope

string

query

False

Filter by scope

host

string

query

False

Filter by host

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

certificate

certificate

host

string

The SAML service provider host.

scope

string

Scope of the entity. Set to "cluster" for cluster owned objects and to "svm" for SVM owned objects.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "certificate": {
    "ca": "string",
    "common_name": "cluster1",
    "serial_number": "1506B24A94F566BA"
  },
  "host": "string",
  "scope": "string"
}

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.