Skip to main content
POST
/
api
/
v2
/
sso-providers
/
saml
Create a New SAML Provider from Metadata
curl --request POST \
  --url https://bloodhound.specterops.io/openapi.json/api/v2/sso-providers/saml \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'name=<string>' \
  --form metadata='@example-file' \
  --form config.auto_provision.enabled=true \
  --form config.auto_provision.default_role_id=3 \
  --form config.auto_provision.role_provision=false
{
  "data": {
    "id": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": {
      "time": "2023-11-07T05:31:56Z",
      "valid": true
    },
    "name": "<string>",
    "display_name": "<string>",
    "idp_issuer_uri": "<string>",
    "idp_sso_uri": "<string>",
    "principal_attribute_mappings": [
      "<string>"
    ],
    "sp_issuer_uri": "<string>",
    "sp_sso_uri": "<string>",
    "sp_metadata_uri": "<string>",
    "sp_acs_uri": "<string>",
    "sso_provider_id": {
      "int32": 123,
      "valid": true
    }
  }
}
Applies to BloodHound Enterprise and CE

Authorizations

​
Authorization
string
header
required

Authorization: Bearer $JWT_TOKEN

Body

multipart/form-data
​
name
string
required

Name of the new SAML provider.

​
metadata
file
required

Metadata XML file.

​
config.auto_provision.enabled
string
required

boolean that, if enabled, allows SSO providers to auto provision bloodhound users on initial login

Example:

"true"

​
config.auto_provision.default_role_id
string
required

default role id for the user created from SSO provider auto provision

Example:

"3"

​
config.auto_provision.role_provision
string
required

boolean that, if enabled, allows sso providers to manage roles for newly created users

Example:

"false"

Response

OK

​
data
object