service_connectors

Validate And Verify Service Connector

Verifies if a service connector instance has access to one or more resources.

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: The ID of the service connector to verify. resource_type: The type of resource to verify access to. resource_id: The ID of the resource to verify access to. list_resources: If True, the list of all resources accessible through the service connector and matching the supplied resource type and ID are returned.

Returns: The list of resources that the service connector has access to, scoped to the supplied resource type and ID, if provided.

put/api/v1/service_connectors/{connector_id}/verify

Request

The document declares no server URL.
Auth
OAuth 2
Password
Token URL/api/v1/login
TypeScript
https://skmtc.dev/zenml-io/apis/zenml-2/docs/api/v1/service_connectors/:connector_id/verify/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

connector_idstring uuid required

Query parameters

resource_typestring nullable

resource_idstring nullable

list_resourcesboolean

Response

Successful Response

idstring uuid nullable

namestring nullable

errorstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.