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
Path parameters
connector_idstring · uuidRequired
Query parameters
resource_typeany ofOptional
stringOptional
or
nullOptional
resource_idany ofOptional
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
GET /api/v1/service_connectors/{connector_id}/client HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "body": {
    "created": "2025-09-18T22:36:09.446Z",
    "updated": "2025-09-18T22:36:09.446Z",
    "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": "2025-09-18T22:36:09.446Z",
    "expires_skew_tolerance": 1
  },
  "metadata": {
    "configuration": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "expiration_seconds": 1,
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "resources": {
    "user": {
      "body": {
        "created": "2025-09-18T22:36:09.446Z",
        "updated": "2025-09-18T22:36:09.446Z",
        "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"
}

Last updated

Was this helpful?