Skip to content
deploybase

Test an SSO connection

POST
/api/v1/team/sso/connections/{id}/test
 
curl --request POST \
  --url https://api.deploybase.eu/api/v1/api/v1/team/sso/connections/example/test \
  --header 'Authorization: <Authorization>'

Re-fetches the STORED issuer’s discovery document and reads the provider back from Zitadel, then reports a pass/fail line per check: issuer_reachable, issuer_matches, metadata_complete, pkce_s256_advertised (fails when the provider lists its PKCE methods and S256 is not among them; passes with a note when it lists none), id_token_alg_supported, token_auth_supported, zitadel_provider_exists, zitadel_issuer_in_sync, zitadel_client_id_in_sync. A failing connection is still a 200 with ok=false — the checks are the answer. Nothing is written. Team admin or owner.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
id
required
string

Connection UUID

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

OK

Media type application/json
object
data
meta
object
request_id
string
timestamp
string
trace_id
string
data
object
checks
Array<object>
object
detail
string
name
string
passed
boolean
ok
boolean
warnings
Array<object>
object
code
string
docs_url
string
message
string
Example generated 
{
  "data": {
    "checks": [
      {
        "detail": "example",
        "name": "example",
        "passed": true
      }
    ],
    "ok": true,
    "warnings": [
      {
        "code": "example",
        "docs_url": "example",
        "message": "example"
      }
    ]
  },
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

400

Section titled “ 400 ”

Bad Request

Media type application/json
object
code
string
details
error
string
meta
object
request_id
string
timestamp
string
trace_id
string
Example generated 
{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

401

Section titled “ 401 ”

Unauthorized

Media type application/json
object
code
string
details
error
string
meta
object
request_id
string
timestamp
string
trace_id
string
Example generated 
{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

403

Section titled “ 403 ”

Forbidden

Media type application/json
object
code
string
details
error
string
meta
object
request_id
string
timestamp
string
trace_id
string
Example generated 
{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

404

Section titled “ 404 ”

Not Found

Media type application/json
object
code
string
details
error
string
meta
object
request_id
string
timestamp
string
trace_id
string
Example generated 
{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

502

Section titled “ 502 ”

SSO_PROVIDER_ERROR

Media type application/json
object
code
string
details
error
string
meta
object
request_id
string
timestamp
string
trace_id
string
Example generated 
{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

503

Section titled “ 503 ”

SSO_NOT_CONFIGURED

Media type application/json
object
code
string
details
error
string
meta
object
request_id
string
timestamp
string
trace_id
string
Example generated 
{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}