The contract a customer implements to connect any content repository that has no prebuilt Pryon connector — discover content sources with pagination, download content data in parts, return content metadata, and expose read permission groups and their members so document-level ACLs survive ingestion.
{"openapi":"3.0.1","info":{"title":"pryon/api/ext/connector/v1alpha1/connector.proto","version":"1.0"},"servers":[{"url":"/"}],"paths":{"/api/connector/v1alpha1/connectors/{connector_id}/content-data:download":{"get":{"description":"Use custom methods to get ContentData to download in multiple parts.","operationId":"ConnectorServiceExternal_DownloadContentData","parameters":[{"description":"Unique identifier for the connector associated with the request.","in":"path","name":"connector_id","required":true,"schema":{"type":"string"}},{"in":"query","name":"range_header.range_start","schema":{"format":"int64","type":"string","description":"Beginning byte range that allows for resuming interrupted downloads and retrieving specific parts of a file; format is range: unit=range-start."}},{"in":"query","name":"range_header.range_end","schema":{"format":"int64","type":"string","description":"Ending byte range that allows for resuming interrupted downloads and retrieving specific parts of a file; format is range: unit=range-end."}},{"in":"query","name":"range_header.total_size","schema":{"format":"int64","description":"Total range size.","type":"string"}},{"description":"Hidden string with additional information the PULL API uses to retrieve the content data and source location from the underlying content; for example, drinve_id + item_id in SharePoint.","in":"query","name":"opaque_data","schema":{"type":"string"}},{"description":"Unique identifier for the content source.","in":"query","name":"source_location","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1alpha1ContentDataResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Get Content Information","tags":["ConnectorServiceExternal"]}},"/api/connector/v1alpha1/connectors/{connector_id}/content/metadata":{"get":{"operationId":"ConnectorServiceExternal_GetMetadata","parameters":[{"description":"Unique identifier of the connector associated with the metadata request.","in":"path","name":"connector_id","required":true,"schema":{"type":"string"}},{"description":"Hidden string with additional information the PULL API uses to retrieve the content data and source location from the underlying content; for example, drinve_id + item_id in SharePoint.","in":"query","name":"opaque_data","schema":{"type":"string"}},{"description":"Unique identifier for the content source.","in":"query","name":"source_location","schema":{"type":"string"}},{"description":"Unique identifier for the content.","in":"query","name":"content_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1alpha1GetMetadataResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Get Content Metadata","tags":["ConnectorServiceExternal"]}},"/api/connector/v1alpha1/connectors/{connector_id}/content/read-permission":{"get":{"operationId":"ConnectorServiceExternal_GetReadPermission","parameters":[{"description":"Unique identifier for the connector associated with the request.","in":"path","name":"connector_id","required":true,"schema":{"type":"string"}},{"description":"Hidden string with additonal information the PULL API uses to retrieve the content data and source location from the underlying content; for example, drinve_id + item_id in SharePoint.","in":"query","name":"opaque_data","schema":{"type":"string"}},{"description":"Unique identifier for the content source.","in":"query","name":"source_location","schema":{"type":"string"}},{"description":"Unique identifier for the content.","in":"query","name":"content_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1alpha1GetReadPermissionResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Get Read Permission for Content","tags":["ConnectorServiceExternal"]}},"/api/connector/v1alpha1/connectors/{connector_id}/contents:pull":{"get":{"operationId":"ConnectorServiceExternal_PullContents","parameters":[{"description":"Unique identifier of the connector associated with the request.","in":"path","name":"connector_id","required":true,"schema":{"type":"string"}},{"description":"Unique identifier for the content.","in":"query","name":"seed_source_location","schema":{"type":"string"}},{"description":"Maximum page size is 100; default is 100.","in":"query","name":"page_size","schema":{"format":"int32","type":"integer"}},{"description":"Hidden token that determines the starting point for the next set of results; if not specified, the server fetches from the first record; if there are multiple pages, specify this value in pages 2-N using the value of next_page_token.","in":"query","name":"page_token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1alpha1ListContentsResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Discover Content Source","tags":["ConnectorServiceExternal"]}},"/api/connector/v1alpha1/connectors/{connector_id}/group-permission/members":{"get":{"operationId":"ConnectorServiceExternal_ListGroupPermissionMembers","parameters":[{"description":"Unique identifier for the connector associated with the request.","in":"path","name":"connector_id","required":true,"schema":{"type":"string"}},{"description":"Unique identifier for the group.","in":"query","name":"group_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1alpha1ListGroupPermissionMembersResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"List Connector Group Permissions","tags":["ConnectorServiceExternal"]}},"/api/connector/v1alpha1/connectors/{connector_id}/group-permissions":{"get":{"operationId":"ConnectorServiceExternal_ListGroupPermissions","parameters":[{"description":"Unique identifier of the connector associated with the request.","in":"path","name":"connector_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1alpha1ListGroupPermissionsResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"List Connector Group Permissions","tags":["ConnectorServiceExternal"]}}},"components":{"schemas":{"ContentTaskValue":{"default":"UNSPECIFIED","description":"Optional for Proxy connectors.","type":"string"},"googlerpcStatus":{"properties":{"code":{"format":"int32","type":"integer"},"message":{"type":"string"},"details":{"items":{"$ref":"#/components/schemas/protobufAny"},"type":"array"}},"type":"object"},"protobufAny":{"properties":{"type_url":{"type":"string"},"value":{"format":"byte","pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","type":"string"}},"type":"object"},"protobufNullValue":{"default":"NULL_VALUE","description":"`NullValue` is a singleton enumeration to represent the null value for the\n`Value` type union.\n\n The JSON representation for `NullValue` is JSON `null`.\n\n - NULL_VALUE: Null value.","enum":["NULL_VALUE"],"type":"string"},"v1alpha1CollectionMetadata":{"properties":{"uuid":{"description":"Unique identifier for the interaction returned in the resource response; the response ID.","type":"string"},"response_time_millis":{"description":"Response time (in milliseconds).","format":"int64","type":"integer"}},"title":"Metadata that will be returned with each collection-level GET","type":"object"},"v1alpha1Content":{"properties":{"content_id":{"description":"Unique identifier for the entity; only required for GetContentResponse.","type":"string"},"connector_id":{"description":"Unique identifier of the connector; only required for GetContentResponse.","type":"string"},"seed_source_location":{"description":"Unique identifier used for content discovery; the Content Group source location for the collection domain.","type":"string"},"source_location":{"description":"Unique identifier for the content.","type":"string"},"display_source_location":{"description":"User-facing source location if different from original source location.","type":"string"},"is_folder":{"description":"Indicates if content is a folder; a folder is not ingested, but recursively discovers other contents.","type":"boolean"},"parent_id":{"description":"Indicates if content is embedded in another content source: links related content items when previewing, for example, a record that has related attachments to be processed separately in different pipelines.","type":"string"},"read_permission":{"$ref":"#/components/schemas/v1alpha1ReadPermission"},"version":{"description":"Content version.","type":"string"},"created_at":{"description":"Date and time the content was originally created.","format":"int64","type":"string"},"updated_at":{"description":"Date and time the content was last updated.","format":"int64","type":"string"},"title":{"description":"Content title.","type":"string"},"description":{"description":"Brief description, summary or abstract of the content.","type":"string"},"comment":{"description":"Comments or annotations associated with the content.","type":"string"},"body":{"description":"Body of the content for non-files, for example, articles or reports; maximum is 1MB.","type":"string"},"mime_type":{"description":"MIME type for file content.","type":"string"},"file_extension":{"description":"File extension (.pdf, .docx, .html, etc.)","type":"string"},"path":{"description":"File path or location within a file system.","type":"string"},"size":{"description":"Size of the file in bytes.","format":"int64","type":"string"},"opaque_data":{"description":"Hidden string with additional information the PULL API uses to retrieve the content data and source location from the underlying content; for example, drinve_id + item_id in SharePoint; only when the universal connector pushes content to the Pryon Ingestion Platform.","type":"string"},"data":{"description":"Base64 encoded data for files less than 4 MB; only when the universal connector pushes content to the Pryon Ingestion Platform.","type":"string"},"created_by":{"description":"Content creator or author in connected platform.","type":"string"},"updated_by":{"description":"Unique identifier for user who last updated the content in connected platform.","type":"string"},"assigned_to":{"description":"Unique identifier for user assigned a task or content.","type":"string"},"impact":{"$ref":"#/components/schemas/ContentTaskValue"},"priority":{"$ref":"#/components/schemas/ContentTaskValue"},"urgency":{"$ref":"#/components/schemas/ContentTaskValue"},"state":{"$ref":"#/components/schemas/ContentTaskValue"},"status":{"$ref":"#/components/schemas/ContentTaskValue"},"custom_attributes":{"additionalProperties":{"$ref":"#/components/schemas/v1alpha1CustomAttribute"},"description":"Custom attributes that are not part of the recommended set; used for fields that do not match another field in the content message type.","type":"object"},"system_status":{"$ref":"#/components/schemas/v1alpha1ContentStatus"},"system_status_reason":{"description":"Detailed reason for the system status.","type":"string"}},"type":"object"},"v1alpha1ContentDataResponse":{"description":"<bytes-data>","properties":{"content_range_header":{"$ref":"#/components/schemas/v1alpha1Range"},"bytes_data":{"format":"byte","pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","type":"string"}},"title":"The response contains the Content-Range header and the content data.\nHTTP/1.1 206 Partial Content\nContent-Range: bytes <range-start>-<range-end>/<total_size>\nContent-Length: <bytes-length>\nContent-Type: application/octet-stream","type":"object"},"v1alpha1ContentStatus":{"default":"UNKNOWN","description":"The Connector Content system status is only updated by the server.\nDo not set on proxy integrations.\n\n - INITIATED: The content has been identified for processing but has not yet been processed.\nIndicates that the content has been identified and is ready to start the uploading and downloading content data steps.\n - UPLOADING: Indicates that the content is currently being uploaded in parts. This status is useful if you want to track the progress of the upload before all parts are complete.\n - UPLOAD_COMPLETE: Indicates that all parts of the content have been successfully uploaded and the content is ready to be processed.\n - DOWNLOADING: Indicates that the content is currently being downloaded in parts. This status can be used if there's a need to track the progress of the download before all parts are complete.\n - DOWNLOAD_COMPLETE: Indicates that all parts of the content have been successfully downloaded and the content is ready to be processed.\n - PROCESSED: The content has been successfully processed and is ready for ETL and indexing steps.\n - FAILED: There was an error while processing this piece of content. The error could be due to various reasons, such as format issues or communication problems with the source.\n - DELETED: The content has been removed, either because it was deleted from the source and was detected and propagated during the synchronization process.","type":"string"},"v1alpha1CustomAttribute":{"properties":{"name":{"description":"The name of the attribute.","type":"string"},"value":{"description":"The value of the attribute.","type":"string"},"value_type":{"$ref":"#/components/schemas/v1alpha1CustomAttributeType"}},"type":"object"},"v1alpha1CustomAttributeType":{"default":"UNKNOWN","enum":["UNKNOWN","STRING","LONG","DOUBLE","DATETIME","BOOLEAN"],"type":"string"},"v1alpha1GetMetadataResponse":{"properties":{"data_source_metadata":{"properties":{},"description":"The raw JSON blob of the metadata from the data source or system of record (SOR).","type":"object"}},"type":"object"},"v1alpha1GetReadPermissionResponse":{"properties":{"metadata":{"$ref":"#/components/schemas/v1alpha1ResourceMetadata"},"data":{"$ref":"#/components/schemas/v1alpha1ReadPermission"}},"type":"object"},"v1alpha1GroupPermission":{"properties":{"group_id":{"description":"Unique identifier for a group.","type":"string"},"group_name":{"description":"The group name.","type":"string"},"group_email":{"description":"The group email.","type":"string"}},"type":"object"},"v1alpha1ListContentItem":{"properties":{"data":{"$ref":"#/components/schemas/v1alpha1Content"},"metadata":{"$ref":"#/components/schemas/v1alpha1ResourceMetadata"}},"type":"object"},"v1alpha1ListContentsResponse":{"properties":{"metadata":{"$ref":"#/components/schemas/v1alpha1CollectionMetadata"},"items":{"description":"Array of contents that match the request.","items":{"$ref":"#/components/schemas/v1alpha1ListContentItem"},"type":"array"},"next_page_token":{"description":"For multiple pages; must be specified in each request for two pages per sheet.","type":"string"}},"type":"object"},"v1alpha1ListGroupPermissionMembersResponse":{"properties":{"emails":{"items":{"description":"List of emails and associated content permissions.","type":"string"},"description":"List of emails and associated content permissions.","type":"array"}},"type":"object"},"v1alpha1ListGroupPermissionsResponse":{"properties":{"items":{"additionalProperties":{"$ref":"#/components/schemas/v1alpha1GroupPermission"},"description":"Maps group IDs to group permissions.","type":"object"}},"type":"object"},"v1alpha1Range":{"properties":{"range_start":{"format":"int64","type":"string"},"range_end":{"format":"int64","type":"string"},"total_size":{"format":"int64","type":"string"}},"type":"object"},"v1alpha1ReadPermission":{"properties":{"allow_emails":{"description":"List of emails with read permission for the content.","items":{"type":"string"},"type":"array"},"allow_group_ids":{"description":"List of group IDs with read permission for the content.","items":{"type":"string"},"type":"array"},"deny_emails":{"description":"List of emails without read permission for the content.","items":{"type":"string"},"type":"array"},"deny_group_ids":{"description":"List of group IDs without read permission for the content.","items":{"type":"string"},"type":"array"},"any_required_group_ids":{"description":"User must belong to at least one of the listed groups in order to access the content; read permission can still be restricted for users of the group.","items":{"type":"string"},"type":"array"},"all_required_group_ids":{"description":"User must belong to all of the listed groups in order to access the content; read permission can still be restricted for users of the group.","items":{"type":"string"},"type":"array"},"is_public":{"description":"Public content flag.","type":"boolean"},"unrestricted_emails":{"description":"List of emails that are always allowed read permission for the content.","items":{"type":"string"},"type":"array"}},"type":"object"},"v1alpha1ResourceMetadata":{"properties":{"uuid":{"description":"Unique identifier for the interaction returned in the resource response; the response ID.","type":"string"},"create_time":{"description":"Time of the initial request.","format":"date-time","type":"string"},"update_time":{"description":"Time of the last update; 0 indicates updates have never been made.","format":"date-time","type":"string"},"response_time_millis":{"format":"int64","description":"Response time (in milliseconds).","type":"integer"}},"type":"object"}}},"x-original-swagger-version":"2.0"}