Client

Get Service Connector Client

get

Get a service connector client for a service connector and given resource.

This requires the service connector implementation to be installed on the ZenML server, otherwise a 501 Not Implemented error will be returned.

Args: connector_id: ID of the service connector. resource_type: Type of the resource to list. resource_id: ID of the resource to list.

Returns: A service connector client that can be used to access the given resource.

Authorizations

CookieOAuth2TokenBearer

OAuth2passwordRequired

Token URL:

Path parameters

connector_idstring · uuidRequired

Query parameters

resource_typestring · nullableOptional

resource_idstring · nullableOptional

Responses

200

Successful Response

application/json

Response model for service connectors.

idstring · uuidRequired

permission_deniedbooleanOptionalDefault: false

namestring · max: 255Required

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

422

Unprocessable Entity

application/json

get/api/v1/service_connectors/{connector_id}/client

HTTPcURLJavaScriptPython

GET /api/v1/service_connectors/{connector_id}/client HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "body": {
    "created": "2026-07-19T11:53:14.816Z",
    "updated": "2026-07-19T11:53:14.816Z",
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "description": "",
    "connector_type": "text",
    "auth_method": "text",
    "resource_types": [
      "text"
    ],
    "resource_id": "text",
    "supports_instances": false,
    "expires_at": "2026-07-19T11:53:14.816Z",
    "expires_skew_tolerance": 1
  },
  "metadata": {
    "configuration": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "expiration_seconds": 1,
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "resources": {
    "user": {
      "body": {
        "created": "2026-07-19T11:53:14.816Z",
        "updated": "2026-07-19T11:53:14.816Z",
        "active": false,
        "activation_token": "text",
        "full_name": "",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true,
        "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
        "avatar_url": "text"
      },
      "metadata": {
        "email": "",
        "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_metadata": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": false,
      "name": "text"
    },
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": false,
  "name": "text"
}