Update an existing third party connector
Update an existing third party connector
Third party connector to update
|
_id
string
required |
|
type
string
required
Value
aws
|
|
name
string
required |
|
throttleDuration
string
required |
|
region
string
required |
|
renewalPeriod
string | null
|
|
timeout
string | null
|
|
proxy
string | null
|
|
credentials
string | null
Name of the password credentials containing Access Key Id and Secret Access Key. If not defined, an account present in environment variables can be used. |
|
resourceGroupName
string | null
|
|
roleArn
string | null
|
|
tagKey
string | null
|
|
tagValue
string | null
|
|
_id
string
required |
|
type
string
required
Value
f5client
|
|
name
string
required |
|
throttleDuration
string
required |
|
throttleParallelism
integer
required |
|
bigIPHostname
string
required |
|
credentials
string
requiredName of the password credentials containing the account to authenticate on F5 |
|
keyType
string | null (Keytype)
Enum
rsa-<size>
ec-secp256r1
ec-secp384r1
ec-secp521r1
ed-Ed448
ed-Ed25519
|
|
renewalPeriod
string | null
|
|
timeout
string | null
|
|
proxy
string | null
|
|
maxStoredCertificatePerHolder
integer | null
|
|
partition
string | null
|
|
sslParent
string | null
|
|
prefix
string | null
|
|
cipherGroup
string | null
|
|
version
string | null
|
|
_id
string
required |
|
type
string
required
Value
intune
|
|
name
string
required |
|
throttleDuration
string
required |
|
throttleParallelism
integer
required |
|
tenant
string
required |
|
credentials
string
requiredName of the password credentials containing the App ID and Key to authenticate on Intune |
|
legacyRevocationMode
boolean
required |
|
timeout
string | null
|
|
proxy
string | null
|
|
intuneResourceUrl
string | null
|
|
osQueryString
string | null
|
|
_id
string
required |
|
type
string
required
Value
jamf
|
|
name
string
required |
|
throttleDuration
string
required |
|
throttleParallelism
integer
required |
|
endpoint
string
required |
|
credentials
string
requiredName of the password credentials containing the account to authenticate on JAMF |
|
timeout
string | null
|
|
proxy
string | null
|
|
_id
string
required |
|
type
string
required
Value
msad
|
|
name
string
required |
|
throttleDuration
string
required |
|
throttleParallelism
integer
required |
|
hostname
string
required |
|
credentials
string
requiredName of the password credentials containing the DN and password to authenticate on Active Directory |
|
baseDn
string
required |
|
timeout
string | null
|
|
maxStoredCertificatePerHolder
integer | null
|
|
proxy
string | null
|
|
port
integer | null
|
|
filter
string | null
|
|
_id
string
required |
|
type
string
required
Value
intunepkcs
|
|
name
string
required |
|
throttleDuration
string
required |
|
throttleParallelism
integer
required |
|
tenant
string
required |
|
credentials
string
requiredName of the password credentials containing the App ID and Key to authenticate on Intune PKCS |
|
pubKey
string
required |
|
keyName
string
required |
|
keyType
string | null (Keytype)
Enum
rsa-<size>
ec-secp256r1
ec-secp384r1
ec-secp521r1
ed-Ed448
ed-Ed25519
|
|
renewalPeriod
string | null
|
|
timeout
string | null
|
|
maxStoredCertificatePerHolder
integer | null
|
|
proxy
string | null
|
|
providerName
string | null
|
|
intendedPurpose
string | null
|
|
searchFilter
string | null
|
|
_id
string
required |
|
type
string
required
Value
akv
|
|
name
string
required |
|
throttleDuration
string
required |
|
throttleParallelism
integer
required |
|
tenant
string
required |
|
credentials
string
requiredName of the password credentials containing the App ID and Key to authenticate on AKV |
|
vaultBaseUrl
string
required |
|
renewalPeriod
string | null
|
|
timeout
string | null
|
|
proxy
string | null
|
|
prefix
string | null
|
|
_id
string
required |
|
type
string
required
Value
gcm
|
|
name
string
required |
|
throttleDuration
string
required |
|
project
string
required |
|
location
string
required |
|
credentials
string
requiredName of the raw credentials containing User Account credentials. |
|
renewalPeriod
string | null
|
|
timeout
string | null
|
|
proxy
string | null
|
|
tagKey
string | null
|
|
tagValue
string | null
|
|
_id
string
required |
|
type
string
required
Value
ldappub
|
|
name
string
required |
|
hostname
string
required |
|
baseDn
string
required |
|
userIdentifierAttribute
string
requiredBefore 2.6.9, the allowed values were CN or RFC822MAIL
Enum
CN
MAIL
UID
|
|
certificateAttribute
string
requiredNew mandatory field in 2.6.9
Enum
CN
UID
SERIALNUMBER
SURNAME
GIVENNAME
T
UNSTRUCTUREDADDRESS
UNSTRUCTUREDNAME
E
OU
ORGANIZATIONIDENTIFIER
PSEUDONYM
UNIQUEIDENTIFIER
STREET
ST
L
O
C
DESCRIPTION
DC
RFC822NAME
DNSNAME
URI
IPADDRESS
OTHERNAME_UPN
OTHERNAME_GUID
|
|
throttleDuration
string
required |
|
credentials
string
requiredName of the password credentials containing login DN and password. |
|
port
integer | null
|
|
filter
string | null
|
|
certAttr
string | null
|
|
followReferrals
boolean | null
|
|
throttleParallelism
integer
|
|
timeout
string | null
|
|
proxy
string | null
|
|
maxStoredCertificatePerHolder
integer | null
|
-
200 Third party connector successfully updated
application/json_idstring requiredtypestring requiredValueawsnamestring requiredthrottleDurationstring requiredregionstring requiredrenewalPeriodstring | nulltimeoutstring | nullproxystring | nullcredentialsstring | nullName of the password credentials containing Access Key Id and Secret Access Key. If not defined, an account present in environment variables can be used.
resourceGroupNamestring | nullroleArnstring | nulltagKeystring | nulltagValuestring | null_idstring requiredtypestring requiredValuef5clientnamestring requiredthrottleDurationstring requiredthrottleParallelisminteger requiredbigIPHostnamestring requiredcredentialsstring requiredName of the password credentials containing the account to authenticate on F5
keyTypestring | null (Keytype)Enumrsa-<size>ec-secp256r1ec-secp384r1ec-secp521r1ed-Ed448ed-Ed25519renewalPeriodstring | nulltimeoutstring | nullproxystring | nullmaxStoredCertificatePerHolderinteger | nullpartitionstring | nullsslParentstring | nullprefixstring | nullcipherGroupstring | nullversionstring | null_idstring requiredtypestring requiredValueintunenamestring requiredthrottleDurationstring requiredthrottleParallelisminteger requiredtenantstring requiredcredentialsstring requiredName of the password credentials containing the App ID and Key to authenticate on Intune
legacyRevocationModeboolean requiredtimeoutstring | nullproxystring | nullintuneResourceUrlstring | nullosQueryStringstring | null_idstring requiredtypestring requiredValuejamfnamestring requiredthrottleDurationstring requiredthrottleParallelisminteger requiredendpointstring requiredcredentialsstring requiredName of the password credentials containing the account to authenticate on JAMF
timeoutstring | nullproxystring | null_idstring requiredtypestring requiredValuemsadnamestring requiredthrottleDurationstring requiredthrottleParallelisminteger requiredhostnamestring requiredcredentialsstring requiredName of the password credentials containing the DN and password to authenticate on Active Directory
baseDnstring requiredtimeoutstring | nullmaxStoredCertificatePerHolderinteger | nullproxystring | nullportinteger | nullfilterstring | null_idstring requiredtypestring requiredValueintunepkcsnamestring requiredthrottleDurationstring requiredthrottleParallelisminteger requiredtenantstring requiredcredentialsstring requiredName of the password credentials containing the App ID and Key to authenticate on Intune PKCS
pubKeystring requiredkeyNamestring requiredkeyTypestring | null (Keytype)Enumrsa-<size>ec-secp256r1ec-secp384r1ec-secp521r1ed-Ed448ed-Ed25519renewalPeriodstring | nulltimeoutstring | nullmaxStoredCertificatePerHolderinteger | nullproxystring | nullproviderNamestring | nullintendedPurposestring | nullsearchFilterstring | null_idstring requiredtypestring requiredValueakvnamestring requiredthrottleDurationstring requiredthrottleParallelisminteger requiredtenantstring requiredcredentialsstring requiredName of the password credentials containing the App ID and Key to authenticate on AKV
vaultBaseUrlstring requiredrenewalPeriodstring | nulltimeoutstring | nullproxystring | nullprefixstring | null_idstring requiredtypestring requiredValuegcmnamestring requiredthrottleDurationstring requiredprojectstring requiredlocationstring requiredcredentialsstring requiredName of the raw credentials containing User Account credentials.
renewalPeriodstring | nulltimeoutstring | nullproxystring | nulltagKeystring | nulltagValuestring | null_idstring requiredtypestring requiredValueldappubnamestring requiredhostnamestring requiredbaseDnstring requireduserIdentifierAttributestring requiredBefore 2.6.9, the allowed values were CN or RFC822MAIL
EnumCNMAILUIDcertificateAttributestring requiredNew mandatory field in 2.6.9
EnumCNUIDSERIALNUMBERSURNAMEGIVENNAMETUNSTRUCTUREDADDRESSUNSTRUCTUREDNAMEEOUORGANIZATIONIDENTIFIERPSEUDONYMUNIQUEIDENTIFIERSTREETSTLOCDESCRIPTIONDCRFC822NAMEDNSNAMEURIIPADDRESSOTHERNAME_UPNOTHERNAME_GUIDthrottleDurationstring requiredcredentialsstring requiredName of the password credentials containing login DN and password.
portinteger | nullfilterstring | nullcertAttrstring | nullfollowReferralsboolean | nullthrottleParallelismintegertimeoutstring | nullproxystring | nullmaxStoredCertificatePerHolderinteger | null -
400 Bad Request
application/jsonerrorstring requiredThe error code of the problem
ValueTHIRDPARTY-CONNECTOR-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid third party Connectortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid third party Connectordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
401 Unauthorized request
application/jsonerrorstring requiredThe error code of the problem
ValueSEC-AUTH-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected Errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected Errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid credentials or principal does not existtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid credentials or principal does not existdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-003messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is not trustedtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is not trusteddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-004messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is expiredtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is expireddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-005messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is revokedtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is revokeddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-006messagestring requiredA short, human-readable summary of the problem type
ValuePrincipal not authenticated or authentication expiredtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValuePrincipal not authenticated or authentication expireddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-007messagestring requiredA short, human-readable summary of the problem type
ValueInvalid Identity Providertitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid Identity Providerdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-008messagestring requiredA short, human-readable summary of the problem type
ValueInvalid redirect pathtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid redirect pathdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-009messagestring requiredA short, human-readable summary of the problem type
ValuePrincipal not authenticated or authentication expiredtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValuePrincipal not authenticated or authentication expireddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
403 Forbidden action
application/jsonerrorstring requiredThe error code of the problem
ValueSEC-PERM-001messagestring requiredA short, human-readable summary of the problem type
ValueInsufficient privilegestitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInsufficient privilegesdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid Licensetitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid Licensedetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-004messagestring requiredA short, human-readable summary of the problem type
ValueExpired Licensetitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueExpired Licensedetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
404 Not Found
application/jsonerrorstring requiredThe error code of the problem
ValueTHIRDPARTY-CONNECTOR-003messagestring requiredA short, human-readable summary of the problem type
ValueThird party Connector not foundtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueThird party Connector not founddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
500 Internal Server error
application/jsonerrorstring requiredThe error code of the problem
ValueTHIRDPARTY-CONNECTOR-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected Errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected Errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected Errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected Errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807