Update SSO Provider

Updates an existing SSO provider. Updating saml provider requires a “multipart/form-data” body. Updating oidc provider requires “application/json” body. Response is respective provider

Authorizations

Authorization

string

header

required

Authorization: Bearer $JWT_TOKEN

Headers

Prefer

integer

default:

0

Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240.

Required range: x > 0

Path Parameters

sso_provider_id

integer

required

SSO Provider ID

Body

name

string

Name of the new SAML provider.

metadata

file

Metadata XML file.

config.auto_provision.enabled

string

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

config.auto_provision.default_role_id

string

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

config.auto_provision.role_provision

string

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

Response

200

application/json

OK

• Option 1
• Option 2

data

object

Show child attributes

data.id

integer

This is the unique identifier for this object.

data.created_at

string

data.updated_at

string

data.deleted_at

object

Show child attributes

data.deleted_at.time

string

An RFC-3339 formatted string

data.deleted_at.valid

boolean

Valid is true if time is not null.

data.name

string

data.display_name

string

data.idp_issuer_uri

string

data.idp_sso_uri

string

data.principal_attribute_mappings

string[]

data.sp_issuer_uri

string

data.sp_sso_uri

string

data.sp_metadata_uri

string

data.sp_acs_uri

string

data.sso_provider_id

object

Show child attributes

data.sso_provider_id.int32

integer

data.sso_provider_id.valid

boolean

Valid is true if int32 is not null.