providers_saml_metadata_retrieve

GET 
/api/v3//providers/saml/:id/metadata/

Return metadata as XML string

Request

Path Parameters

id integerrequired

A unique integer value identifying this SAML Provider.

Query Parameters

download boolean
force_binding string

Possible values: [urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST, urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect]

Optionally force the metadata to only include one binding.

Responses

200

application/json

Schema

Schema

metadata stringrequired
download_url stringrequired

Example (from schema)

{
  "metadata": "string",
  "download_url": "string"
}

400

application/json

Schema

Schema

non_field_errors string[]
code string
property name* any

Validation Error

Example (from schema)

{
  "non_field_errors": [
    "string"
  ],
  "code": "string"
}

403

application/json

Schema

Schema

detail stringrequired
code string

Example (from schema)

{
  "detail": "string",
  "code": "string"
}

404

Provider has no application assigned

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L '/api/v3/providers/saml/:id/metadata/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

Parameters

id — pathrequired

download — query

---truefalse

force_binding — query

---urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POSTurn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect