Auth
Community
Enterprise

Create a New SAML Provider from Metadata

Creates a new SAML provider with the given name and metadata XML.

post/api/v2/sso-providers/saml

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v2/sso-providers/saml
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization and API key in header RequestDate and API key in header Signature

Request body multipart/form-data

namestring required

Name of the new SAML provider.

metadatastring binary required

Metadata XML file.

config.auto_provision.enabledstring required

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

config.auto_provision.default_role_idstring required

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

config.auto_provision.role_provisionstring required

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

Example request

{
  "config.auto_provision.enabled": "true",
  "config.auto_provision.default_role_id": "3",
  "config.auto_provision.role_provision": "false"
}

Response

OK

Changes

No recorded changes to this operation across all 86 revisions of this API.