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

PATCH /api/v2/sso-providers/{sso_provider_id}

Error

A valid request URL is required to generate request examples

200

{
  "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
    }
  }
}

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<int32> · 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

Example:

"true"

config.auto_provision.default_role_id · string

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

Example:

"3"

config.auto_provision.role_provision · string

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

Example:

"false"

Response

200

application/json

OK

Option 1

Option 2

data · object

Show child attributes