### ZenML SDK Reference Source: https://context7_llms Links to the ZenML SDK documentation, including an overview and examples of interacting with the ZenML instance via the Client. ```APIDOC ZenML SDK Reference: Overview: See docstrings for ZenML Code. Client: Reference for the ZenML Client object. Example Usages: Interacting with your ZenML instance through the ZenML Client. Provides code examples for common operations. ``` -------------------------------- ### Server Information API Source: https://context7_llms Endpoint to retrieve general information about the ZenML server. ```APIDOC Server Information API: Server Info: GET /api/v1/server/info Description: Retrieves general information about the ZenML server, such as version and configuration. Returns: Server details object. ``` -------------------------------- ### Authentication API Source: https://context7_llms Comprehensive endpoints for user authentication, including login, logout, authorization flows, managing connections, API tokens, and tenant authorization. ```APIDOC Authentication API: Auth Overview: GET /api/v1/auth Description: Provides general authentication-related information or status. Returns: Authentication status or links. Login: POST /api/v1/auth/login Description: Authenticates a user and returns an access token. Parameters: username: User's username (string). password: User's password (string). Returns: Access token and user information. Connections: GET /api/v1/auth/connections Description: Lists available authentication connection methods. Returns: List of connection providers. Authorize: GET /api/v1/auth/authorize Description: Initiates or continues an OAuth authorization flow. Parameters: client_id: The client application ID (string). redirect_uri: The URI to redirect to after authorization (string). scope: Requested permissions (string). response_type: Type of response expected (e.g., 'code') (string). Returns: Authorization grant or redirect. Callback: GET /api/v1/auth/callback Description: Handles the callback from an OAuth provider after authorization. Parameters: code: The authorization code received from the provider (string). state: The state parameter for security (string). Returns: User session or tokens. Logout: POST /api/v1/auth/logout Description: Logs out the current user and invalidates tokens. Returns: Success message. Device Authorization: POST /api/v1/auth/device-authorization Description: Initiates a device authorization flow. Returns: Device code and verification URI. API Token: POST /api/v1/auth/api-token Description: Generates an API token for programmatic access. Parameters: scopes: Requested scopes for the token (array of strings). Returns: API token and its details. Tenant Authorization: POST /api/v1/auth/tenant-authorization Description: Authorizes access to a specific tenant. Parameters: tenant_id: The ID of the tenant to authorize (string). permissions: Requested permissions for the tenant (array of strings). Returns: Tenant access confirmation. ``` -------------------------------- ### Organizations API Source: https://context7_llms Endpoints for managing ZenML organizations, including entitlement checks and validation of organization names and tenant names. ```APIDOC Organizations API: Entitlement: GET /api/v1/organizations/entitlement Description: Retrieves entitlement information for the current organization. Returns: Entitlement details. Validation: GET /api/v1/organizations/validation Description: General validation endpoint for organizations. Returns: Validation status. Name Validation: GET /api/v1/organizations/validation/name Description: Validates an organization name. Parameters: name: The organization name to validate (string). Returns: Validation result. Tenant Name Validation: GET /api/v1/organizations/validation/tenant-name Description: Validates a tenant name within an organization. Parameters: tenant_name: The tenant name to validate (string). Returns: Validation result. ``` -------------------------------- ### Health and Usage API Source: https://context7_llms Endpoints for checking the health status of the ZenML service and reporting usage events or batches. ```APIDOC Health and Usage API: Health: GET /api/v1/health Description: Checks the overall health status of the ZenML service. Returns: Health status information. Usage Event: POST /api/v1/usage-event Description: Reports a single usage event. Request Body: event_data: Details of the usage event (object). Returns: Confirmation of event submission. Usage Batch: POST /api/v1/usage-batch Description: Reports a batch of usage events. Request Body: events: An array of usage event objects. Returns: Confirmation of batch submission. ``` -------------------------------- ### Role-Based Access Control (RBAC) API Source: https://context7_llms Endpoints for managing roles, permissions, and resource access control within ZenML. ```APIDOC Role-Based Access Control (RBAC) API: Rbac Overview: GET /api/v1/rbac Description: Provides general RBAC information or configuration. Returns: RBAC status or related links. Check Permissions: POST /api/v1/rbac/check-permissions Description: Checks if a user has specific permissions for a resource. Parameters: user_id: The ID of the user (string). resource_id: The ID of the resource (string). action: The action to check permissions for (string). Returns: Boolean indicating if permission is granted. Allowed Resource IDs: GET /api/v1/rbac/allowed-resource-ids Description: Retrieves a list of resource IDs a user has access to. Parameters: user_id: The ID of the user (string). action: The action to filter resources by (string). Returns: Array of resource IDs. Resource Members: GET /api/v1/rbac/resource-members Description: Retrieves members (users or groups) associated with a resource. Parameters: resource_id: The ID of the resource (string). role: The role to filter members by (string, optional). Returns: List of members and their roles. ``` -------------------------------- ### Stigg Webhook API Source: https://context7_llms Endpoint for receiving webhook notifications from Stigg, likely for feature flag updates or billing events. ```APIDOC Stigg Webhook API: Stigg Webhook: POST /api/v1/stigg-webhook Description: Receives webhook events from Stigg. Request Body: payload: The Stigg webhook payload (object). Returns: Acknowledgment of receipt. ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.