Retrieve an existing third party connector
Retrieve an existing third party connector based on its name
|
name
string
required |
-
200 The third party connector
application/json_idstring (Internal ID) requiredObject internal ID
typestring 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 (Internal ID) requiredObject internal ID
typestring requiredValuef5clientnamestring requiredthrottleDurationstring requiredthrottleParallelisminteger requiredbigIPHostnamestring requiredcredentialsstring requiredName of the password credentials containing the account to authenticate on F5
renewalPeriodstring | nulltimeoutstring | nullproxystring | nullmaxStoredCertificatePerHolderinteger | nullpartitionstring | nullsslParentstring | nullprefixstring | nullcipherGroupstring | nullversionstring | nulltlsInsecureboolean | nullAllow invalid server certificates when establishing the TLS connection. Use in production is not recommended.
_idstring (Internal ID) requiredObject internal ID
typestring requiredValuef5as3namestring requiredthrottleDurationstring requiredthrottleParallelisminteger requiredhostnamestring requiredcredentialsstring requiredName of the password credentials containing the account to authenticate on F5
keyTypestring | null (Keytype)One of rsa-2048, rsa-3072, rsa-4096, rsa-8192, ec-secp256r1, ec-secp384r1, ec-secp521r1, ed-448, ed-25519, mldsa-44, mldsa-65, mldsa-87, slhdsa-sha2-128s, slhdsa-sha2-128f, slhdsa-sha2-192s, slhdsa-sha2-192f, slhdsa-sha2-256s, slhdsa-sha2-256f, slhdsa-sha2-128ssha256, slhdsa-sha2-128fsha256, slhdsa-sha2-192ssha512, slhdsa-sha2-192fsha512, slhdsa-sha2-256ssha512, slhdsa-sha2-256fsha512 or
+ renewalPeriodstring | nulltimeoutstring | nullproxystring | nullloginProviderstring | nulltlsInsecureboolean | nullAllow invalid server certificates when establishing the TLS connection. Use in production is not recommended.
_idstring (Internal ID) requiredObject internal ID
typestring 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 (Internal ID) requiredObject internal ID
typestring requiredValuejamfnamestring requiredthrottleDurationstring requiredthrottleParallelisminteger requiredendpointstring requiredcredentialsstring requiredName of the password credentials containing the account to authenticate on JAMF
timeoutstring | nullproxystring | null_idstring (Internal ID) requiredObject internal ID
typestring 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 | nulltlsInsecureboolean | nullAllow invalid server certificates when establishing the TLS connection. Use in production is not recommended.
_idstring (Internal ID) requiredObject internal ID
typestring requiredValueintunepkcsnamestring requiredthrottleDurationstring requiredthrottleParallelisminteger requiredtenantstring requiredcredentialsstring requiredName of the password credentials containing the App ID and Key to authenticate on Intune PKCS
pubKeystring requiredkeyNamestring requiredrenewalPeriodstring | nulltimeoutstring | nullmaxStoredCertificatePerHolderinteger | nullproxystring | nullproviderNamestring | nullintendedPurposestring | nullsearchFilterstring | null_idstring (Internal ID) requiredObject internal ID
typestring 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 (Internal ID) requiredObject internal ID
typestring requiredValuegcmnamestring requiredthrottleDurationstring requiredprojectstring requiredlocationstring requiredcredentialsstring requiredName of the raw credentials containing User Account credentials.
renewalPeriodstring | nulltimeoutstring | nullproxystring | nulltagKeystring | nulltagValuestring | null_idstring (Internal ID) requiredObject internal ID
typestring requiredValueldappubnamestring requiredhostnamestring requiredbaseDnstring requireduserIdentifierAttributestring requiredEnumCNMAILUIDcertificateAttributestring requiredEnumCNUIDSERIALNUMBERSURNAMEGIVENNAMETUNSTRUCTUREDADDRESSUNSTRUCTUREDNAMEEOUORGANIZATIONIDENTIFIERPSEUDONYMUNIQUEIDENTIFIERSTREETSTLOCDESCRIPTIONDCRFC822NAMEDNSNAMEURIIPADDRESSOTHERNAME_UPNOTHERNAME_GUIDREGISTERED_IDthrottleDurationstring requiredcredentialsstring requiredName of the password credentials containing login DN and password.
portinteger | nullfilterstring | nullcertAttrstring | nullfollowReferralsboolean | nullthrottleParallelismintegertimeoutstring | nullproxystring | nullmaxStoredCertificatePerHolderinteger | nulltlsInsecureboolean | nullAllow invalid server certificates when establishing the TLS connection. Use in production is not recommended.
-
401 Unauthorized request
application/problem+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 authenticatedtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValuePrincipal not authenticateddetailstring | 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/problem+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/problem+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/problem+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