Skip to main content
POST
/
v1
/
idps
/
*:test
cURL
curl --request POST \
  --url 'https://api.example.com/v1/idps/*:test' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identityProvider": {
    "name": "<string>",
    "title": "<string>",
    "domain": "<string>",
    "type": "IDENTITY_PROVIDER_TYPE_UNSPECIFIED",
    "config": {
      "oauth2Config": {
        "authUrl": "<string>",
        "tokenUrl": "<string>",
        "userInfoUrl": "<string>",
        "clientId": "<string>",
        "clientSecret": "<string>",
        "scopes": [
          "<string>"
        ],
        "fieldMapping": {
          "identifier": "<string>",
          "displayName": "<string>",
          "phone": "<string>",
          "groups": "<string>"
        },
        "skipTlsVerify": true,
        "authStyle": "OAUTH2_AUTH_STYLE_UNSPECIFIED"
      },
      "oidcConfig": {
        "issuer": "<string>",
        "clientId": "<string>",
        "clientSecret": "<string>",
        "scopes": [
          "<string>"
        ],
        "fieldMapping": {
          "identifier": "<string>",
          "displayName": "<string>",
          "phone": "<string>",
          "groups": "<string>"
        },
        "skipTlsVerify": true,
        "authStyle": "OAUTH2_AUTH_STYLE_UNSPECIFIED"
      },
      "ldapConfig": {
        "host": "<string>",
        "port": 123,
        "skipTlsVerify": true,
        "bindDn": "<string>",
        "bindPassword": "<string>",
        "baseDn": "<string>",
        "userFilter": "<string>",
        "securityProtocol": "SECURITY_PROTOCOL_UNSPECIFIED",
        "fieldMapping": {
          "identifier": "<string>",
          "displayName": "<string>",
          "phone": "<string>",
          "groups": "<string>"
        }
      }
    }
  },
  "oauth2Context": {
    "code": "<string>"
  },
  "oidcContext": {
    "code": "<string>"
  }
}
'
{
  "claims": {},
  "userInfo": {}
}

Body

application/json
identityProvider
object

The identity provider to test connection including uncreated.

oauth2Context
object
oidcContext
object

OIDC authentication context for test connection.

Response

OK

claims
object

The map of claims returned by the identity provider.

userInfo
object

The matched user info from the claims.