Update Embedded Identity Source

Update Embedded Identity Source

Update the identity source associated with the embedded IDP by name, if it exists

Request
URI
PATCH
https://{api_host}/v1/identity-providers/{id}/identity-sources/{domainName}
COPY
Path Parameters
string
id
Required

ID of Identity Provider

string
domainName
Required

Domain Name associated with the identity source

Request Body
IdentitySourceSpec of type(s) application/json
Required

Show optional properties

{
    "name": "string",
    "ldap": {
        "type": "One among: OpenLdap, ActiveDirectory",
        "domainName": "string",
        "username": "string",
        "password": "string",
        "sourceDetails": {
            "usersBaseDn": "string",
            "groupsBaseDn": "string",
            "serverEndpoints": [
                {}
            ]
        }
    }
}
{
    "name": "string",
    "ldap": {
        "type": "One among: OpenLdap, ActiveDirectory",
        "domainName": "string",
        "domainAlias": "string",
        "username": "string",
        "password": "string",
        "sourceDetails": {
            "usersBaseDn": "string",
            "groupsBaseDn": "string",
            "certChain": [
                "string"
            ],
            "serverEndpoints": [
                "string"
            ]
        }
    }
}
string
name
Required

The user-friendly name for the identity Source

object
ldap
Required

The LDAP specification when the protocol is LDAP

Responses
204

No content

Operation doesn't return any data structure

400

Bad Request

Returns Error of type(s) application/json 
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


404

Identity Source not found

Returns Error of type(s) application/json 
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


500

Internal server error

Returns Error of type(s) application/json 
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


Code Samples
COPY 
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"ldap:"object","name:"string"}'
On This Page
Identity Providers Operations
GET
Get Identity Providers
POST
Add External Identity Provider
POST
Generate Sync Client Token
POST
Add Embedded Identity Source
GET
Get Identity Provider By Id
DELETE
Delete External Identity Provider
PATCH
Update External Identity Provider
DELETE
Delete Identity Source
PATCH
Update Embedded Identity Source
GET
Get Sddc Ws1b Oidc Info