Skip to main content

Update a backend

PUT /api/backends/:backend_id updates the identified backend resource

Required scope: identity-providers:manage:all

Path Parameters
backend_id string REQUIRED
Request Body REQUIRED
backend object
id string
name string
type string
is_default boolean
create_default_organization boolean
roles object[]
id string
name string
scopes object[]
id string
name string
public boolean
metadata_fields object[]
federated_servers object[]
verifiable_credentials object[]
verifiable_presentations object[]
password_hashing_alg string
password_hashing_opts object
ldap_pool_size int32
ldap_host string
ldap_user_rdn_attribute string
ldap_base_dn string
ldap_ou string
ldap_master_dn string
ldap_master_password string
smtp_from string
smtp_relay string
smtp_username string
smtp_password string
smtp_ssl boolean
smtp_tls boolean
smtp_port int32
features string[]
Responses
200
Schema OPTIONAL
data object OPTIONAL
id string OPTIONAL
name string OPTIONAL
type string OPTIONAL
is_default boolean OPTIONAL
create_default_organization boolean OPTIONAL
roles object[] OPTIONAL
id string OPTIONAL
name string OPTIONAL
scopes object[] OPTIONAL
id string OPTIONAL
name string OPTIONAL
public boolean OPTIONAL
metadata_fields object[] OPTIONAL
federated_servers object[] OPTIONAL
verifiable_credentials object[] OPTIONAL
verifiable_presentations object[] OPTIONAL
password_hashing_alg string OPTIONAL
password_hashing_opts object OPTIONAL
ldap_pool_size int32 OPTIONAL
ldap_host string OPTIONAL
ldap_user_rdn_attribute string OPTIONAL
ldap_base_dn string OPTIONAL
ldap_ou string OPTIONAL
ldap_master_dn string OPTIONAL
ldap_master_password string OPTIONAL
smtp_from string OPTIONAL
smtp_relay string OPTIONAL
smtp_username string OPTIONAL
smtp_password string OPTIONAL
smtp_ssl boolean OPTIONAL
smtp_tls boolean OPTIONAL
smtp_port int32 OPTIONAL
features string[] OPTIONAL
400

Bad request.

Schema OPTIONAL
errors object OPTIONAL
401

The client is unauthorized to access this resource.

Schema OPTIONAL
code string
message string
403

The client is forbidden to access this resource.

Schema OPTIONAL
code string
message string
404

The requested resource could not be found.

Schema OPTIONAL
code string
message string
422

The request payload is invalid.

Schema OPTIONAL
errors object OPTIONAL