### GET /authentication Source: https://docs.linshare.org/swagger-user-v5/swagger.json No operation. ```APIDOC ## GET /authentication ### Description No operation. ### Method GET ### Endpoint /authentication ``` -------------------------------- ### GET /welcome_messages Source: https://docs.linshare.org/swagger-user-v5/swagger.json Retrieves all welcome message entries. ```APIDOC ## GET /welcome_messages ### Description Find all welcome message entries. ### Method GET ### Endpoint /welcome_messages ### Response #### Success Response (200) - **array** (Object) - Returns an array of welcome message entries. ``` -------------------------------- ### GET /functionalities Source: https://docs.linshare.org/swagger-user-v5/swagger.json Retrieves a list of all available functionalities. ```APIDOC ## GET /functionalities ### Description Retrieves a list of all functionalities available within the domain. ### Method GET ### Endpoint /functionalities ### Response #### Success Response (200) - **FunctionalityDto** (array) - An array of functionality details. #### Response Example ```json { "example": "[\n {\n \"id\": \"func123\",\n \"name\": \"Example Functionality\"\n },\n {\n \"id\": \"func456\",\n \"name\": \"Another Functionality\"\n }\n]" } ``` ``` -------------------------------- ### GET /safe_details Source: https://docs.linshare.org/swagger-user-v5/swagger.json EXPERIMENTAL - Retrieves all safeDetails. ```APIDOC ## GET /safe_details ### Description EXPERIMENTAL - Retrieves all safeDetails. ### Method GET ### Endpoint /safe_details ### Response #### Success Response (200) - **SafeDetail** (array) - A list of all SafeDetail objects. ``` -------------------------------- ### GET /users Source: https://docs.linshare.org/swagger-user-v5/swagger.json Retrieves a list of all users. ```APIDOC ## GET /users ### Description Find all users. ### Method GET ### Endpoint /users ### Response #### Success Response (200) - **array** (UserDto) - Returns an array of UserDto objects. ``` -------------------------------- ### GET /authentication/version Source: https://docs.linshare.org/swagger-delegation-v2/swagger.json Retrieves the current version of the authentication API. ```APIDOC ## GET /authentication/version ### Description Returns the version string of the authentication API. ### Method GET ### Endpoint /authentication/version ### Response #### Success Response (default) - **version** (string) - The API version string. ``` -------------------------------- ### GET /enums Source: https://docs.linshare.org/swagger-admin-v5/swagger.json Retrieves a list of all available enums. ```APIDOC ## GET /enums ### Description Find all available enums. ### Method GET ### Endpoint /enums ### Response #### Success Response (default) - **(array of strings)** - A list of available enum names #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### GET /authentication Source: https://docs.linshare.org/swagger-admin-v5/swagger.json Used for redirection after the user's logging out. ```APIDOC ## GET /authentication ### Description No operation, it is used for redirection after the user's logging out. ### Method GET ### Endpoint /authentication ``` -------------------------------- ### GET /users/autocomplete/{pattern} Source: https://docs.linshare.org/swagger-user-v5/swagger.json Provides user autocompletion based on a search pattern. ```APIDOC ## GET /users/autocomplete/{pattern} ### Description Provide user autocompletion. ### Method GET ### Endpoint /users/autocomplete/{pattern} ### Parameters #### Path Parameters - **pattern** (string) - Required - Pattern to complete. ### Response #### Success Response (200) - **array** (UserDto) - Returns an array of UserDto objects. ``` -------------------------------- ### GET /authentication/password Source: https://docs.linshare.org/swagger-user-v5 Retrieve the password validation rules for the system. ```APIDOC ## GET /authentication/password ### Description Get the password validation rules. ### Method GET ### Endpoint /authentication/password ``` -------------------------------- ### GET /authentication/jwt Source: https://docs.linshare.org/swagger-user-v5/swagger.json Generates a JSON Web Token (JWT). ```APIDOC ## GET /authentication/jwt ### Description Generates a JSON Web Token (JWT) for authentication purposes. ### Method GET ### Endpoint /authentication/jwt ### Response #### Success Response (200) - **JwtToken** (object) - An object containing the JWT. #### Response Example ```json { "token": "string" } ``` ``` -------------------------------- ### GET /guests/{uuid} Source: https://docs.linshare.org/swagger-user-v5/swagger.json Retrieves details for a specific guest by their UUID. ```APIDOC ## GET /guests/{uuid} ### Description Retrieves detailed information about a specific guest using their unique universally unique identifier (UUID). ### Method GET ### Endpoint /guests/{uuid} ### Parameters #### Path Parameters - **uuid** (string) - Required - The universally unique identifier of the guest. ### Response #### Success Response (200) - **Guest** (array) - An array containing guest details. #### Response Example ```json { "example": "[\n {\n \"uuid\": \"a1b2c3d4-e5f6-7890-1234-567890abcdef\",\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\"\n }\n]" } ``` ``` -------------------------------- ### POST /guests Source: https://docs.linshare.org/swagger-admin-v5/swagger.json Creates a new guest account. ```APIDOC ## POST /guests ### Description Create a guest. ### Method POST ### Endpoint /guests ### Parameters #### Request Body - **guest** (Guest) - Required - Guest to create. ### Response #### Success Response (200) - **guests** (array) - List of created guest objects. ``` -------------------------------- ### GET /authentication/2fa/{uuid} Source: https://docs.linshare.org/swagger-user-v5 Get current 2FA state using the account UUID. ```APIDOC ## GET /authentication/2fa/{uuid} ### Description Get current 2FA state. use account uuid as 2FA uuid. ### Method GET ### Endpoint /authentication/2fa/{uuid} ### Parameters #### Path Parameters - **uuid** (string) - Required - The account UUID ``` -------------------------------- ### POST /domains Source: https://docs.linshare.org/swagger-admin-v5 Create a new domain (Root administrator only). ```APIDOC ## POST /domains ### Description It allows root adminstrator to create a new domain. ### Method POST ### Endpoint /domains ``` -------------------------------- ### GET /domains/{domainUuid}/statistics/account_quotas Source: https://docs.linshare.org/swagger-admin-v5 Get storage consumption statistics for account quotas. ```APIDOC ## GET /domains/{domainUuid}/statistics/account_quotas ### Description Get storage consumption statistics. By default will be a 12 rolling months. ### Method GET ### Endpoint /domains/{domainUuid}/statistics/account_quotas ### Parameters #### Path Parameters - **domainUuid** (string) - Required - The UUID of the domain. ``` -------------------------------- ### PUT /domains/{domainUuid}/welcome_messages/{uuid}/assign Source: https://docs.linshare.org/swagger-admin-v5/swagger.json Assigns a welcome message to a domain. ```APIDOC ## PUT /domains/{domainUuid}/welcome_messages/{uuid}/assign ### Description It allows to assign a welcome message. ### Method PUT ### Endpoint /domains/{domainUuid}/welcome_messages/{uuid}/assign #### Path Parameters - **domainUuid** (string) - Required - domain's uuid. - **uuid** (string) - Required - welcomeMessage's uuid to assign. #### Request Body - **WelcomeMessageAssign** (object) - Required - Welcome message assign object. ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **WelcomeMessage** (object) - The assigned welcome message. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Welcome Message Management Source: https://docs.linshare.org/swagger-admin-v5 Endpoints for managing welcome messages. ```APIDOC ## GET /welcome_messages/{uuid}/domains ### Description It will return the domains associated to this welcome message. ### Method GET ### Endpoint /welcome_messages/{uuid}/domains ``` -------------------------------- ### POST /websites/linshare/users Source: https://docs.linshare.org/swagger-admin-v5/swagger.json Creates a new user in the system. ```APIDOC ## POST /websites/linshare/users ### Description Creates a new user in the system. ### Method POST ### Endpoint /websites/linshare/users ### Parameters #### Request Body - **UserV5** (object) - Required - The user object to be created. ### Request Example ```json { "example": "UserV5 object" } ``` ### Response #### Success Response (200) - **UserV5** (array) - The newly created user(s). #### Response Example ```json [ { "example": "UserV5 object" } ] ``` ``` -------------------------------- ### GET /authentication/logout Source: https://docs.linshare.org/swagger-admin-v5/swagger.json Logs out the current user. ```APIDOC ## GET /authentication/logout ### Description Logout the current user. ### Method GET ### Endpoint /authentication/logout ``` -------------------------------- ### POST /users/details Source: https://docs.linshare.org/swagger-delegation-v2 Look for a user LinShare account, creating it from LDAP if it does not exist. ```APIDOC ## POST /users/details ### Description Looking for user LinShare account, if it does not exists it will be created from ldap directories. ### Method POST ### Endpoint /users/details ``` -------------------------------- ### POST /remote_servers Source: https://docs.linshare.org/swagger-admin-v5/swagger.json Creates a new remote server instance. ```APIDOC ## POST /remote_servers ### Description Create a remote server. ### Method POST ### Endpoint /remote_servers ### Parameters #### Request Body - **Server** (object) - Required - The remote server to create. ``` -------------------------------- ### POST /documents Source: https://docs.linshare.org/swagger-user-v5 Create a document from a provided URL. ```APIDOC ## POST /documents ### Description Create a document from an URL. ### Method POST ### Endpoint /documents ``` -------------------------------- ### POST /copy Source: https://docs.linshare.org/swagger-delegation-v2/swagger.json Create a workgroup entry which will contain the uploaded file. ```APIDOC ## POST /copy ### Description Create a workgroup entry which will contain the uploaded file. ### Method POST ### Endpoint /copy ### Parameters #### Path Parameters - **actorUuid** (string) - Required - The actor (user) uuid. - **workgroupUuid** (string) - Required - The workgroup uuid. - **entryUuid** (string) - Required - The document entry uuid. #### Query Parameters - **async** (boolean) - Optional - True to enable asynchronous upload processing. ### Response #### Success Response (200) - **ThreadEntry** (array) - A list of thread entries. ``` -------------------------------- ### GET /workspace_filters Source: https://docs.linshare.org/swagger-admin-v5/swagger.json Retrieve all domain workspace filters. ```APIDOC ## GET /workspace_filters ### Description It will return all domain workSpace filters. ### Method GET ### Endpoint /workspace_filters ### Parameters #### Query Parameters - **model** (boolean) - Optional - It is an optional parameter, if true default domain workSpace filters' models will be returned, else the admins' created ones will be returned. ### Response #### Success Response (200) - **Array** (array) - A list of domain workspace filters. ``` -------------------------------- ### POST /domains/{domainUuid}/welcome_messages Source: https://docs.linshare.org/swagger-admin-v5/swagger.json Creates a new welcome message for a specified domain. ```APIDOC ## POST /domains/{domainUuid}/welcome_messages ### Description It allows to create a new welcome message. ### Method POST ### Endpoint /domains/{domainUuid}/welcome_messages #### Path Parameters - **domainUuid** (string) - Required - domain's uuid. #### Request Body - **WelcomeMessage** (object) - Required - Welcome message to create ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **WelcomeMessage** (object) - Description of the created welcome message. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### GET /group_filters Source: https://docs.linshare.org/swagger-admin-v5/swagger.json Find all domain group filters. ```APIDOC ## GET /group_filters ### Description Find all domain group filters. ### Method GET ### Endpoint /group_filters ### Parameters #### Query Parameters - **model** (boolean) - Optional - It is an optional parameter, if true default domain group filters' models will be returned, else the admins' created ones will be returned. ### Response #### Success Response (200) - **LdapGroupFilter** (array) - A list of LdapGroupFilter objects. ``` -------------------------------- ### GET /async Source: https://docs.linshare.org/swagger-delegation-v2/swagger.json Retrieves the status of an asynchronous task. ```APIDOC ## GET /{actorUuid}/documents/{uuid}/async ### Description Retrieves the status of an asynchronous task. ### Method GET ### Endpoint /{actorUuid}/documents/{uuid}/async ### Parameters #### Path Parameters - **actorUuid** (string) - Required - The actor (user) uuid. - **uuid** (string) - Required - The async task uuid. ### Response #### Success Response (default) - **AsyncTask** (object) - The asynchronous task details. ``` -------------------------------- ### POST /authentication/2fa Source: https://docs.linshare.org/swagger-admin-v5/swagger.json Enables 2FA and returns a shared key. ```APIDOC ## POST /authentication/2fa ### Description Enable 2FA. A shared key will be computend and returned. This is the one and only time the shared key will be returned. ### Method POST ### Endpoint /authentication/2fa ### Parameters #### Request Body - **SecondFactor** (object) - Required - The 2FA configuration object. ### Response #### Success Response (200) - **SecondFactor** (object) - The 2FA object containing the shared key. ``` -------------------------------- ### GET /documents Source: https://docs.linshare.org/swagger-delegation-v2/swagger.json Retrieves all documents for a specific actor. ```APIDOC ## GET /{actorUuid}/documents ### Description Get all documents. ### Method GET ### Endpoint /{actorUuid}/documents ### Parameters #### Path Parameters - **actorUuid** (string) - Required - The actor (user) uuid. ### Response #### Success Response (200) - **Array** (Document) - A list of documents. ``` -------------------------------- ### POST /websites/linshare/{domainUuid}/providers Source: https://docs.linshare.org/swagger-admin-v5/swagger.json Creates a new workspace provider for a given domain. ```APIDOC ## POST /websites/linshare/{domainUuid}/providers ### Description Allows the root administrator to create a new workspace provider for a specified domain. ### Method POST ### Endpoint /websites/linshare/{domainUuid}/providers ### Parameters #### Path Parameters - **domainUuid** (string) - Required - The UUID of the domain for which to create the workspace provider. #### Request Body - **LDAPWorkSpaceProvider** (object) - Required - The workspace provider DTO to create. - **name** (string) - Required - The name of the workspace provider. - **type** (string) - Required - The type of the workspace provider (e.g., LDAP). - **enabled** (boolean) - Optional - Indicates if the workspace provider should be enabled upon creation. - **connectionUrl** (string) - Required for LDAP type - The connection URL for the LDAP server. - **bindDn** (string) - Required for LDAP type - The bind DN for authenticating with the LDAP server. - **bindPassword** (string) - Required for LDAP type - The bind password for authenticating with the LDAP server. - **userBaseDn** (string) - Required for LDAP type - The base DN for searching users in LDAP. - **groupBaseDn** (string) - Required for LDAP type - The base DN for searching groups in LDAP. ### Request Example ```json { "name": "NewLDAPProvider", "type": "LDAP", "enabled": true, "connectionUrl": "ldap://ldap.example.com", "bindDn": "cn=admin,dc=example,dc=com", "bindPassword": "secretpassword", "userBaseDn": "ou=users,dc=example,dc=com", "groupBaseDn": "ou=groups,dc=example,dc=com" } ``` ### Response #### Success Response (200) - **uuid** (string) - The UUID of the newly created workspace provider. - **name** (string) - The name of the workspace provider. - **type** (string) - The type of the workspace provider. - **enabled** (boolean) - Indicates if the workspace provider is enabled. - **creationDate** (string) - The date and time when the workspace provider was created. - **lastUpdateDate** (string) - The date and time when the workspace provider was last updated. #### Response Example ```json { "uuid": "f0e9d8c7-b6a5-4321-fedc-ba9876543210", "name": "NewLDAPProvider", "type": "LDAP", "enabled": true, "creationDate": "2023-10-27T11:00:00Z", "lastUpdateDate": "2023-10-27T11:00:00Z" } ``` #### Error Response (40X) - **code** (integer) - The error code. - **message** (string) - A message describing the error. ``` -------------------------------- ### GET /authentication/logout Source: https://docs.linshare.org/swagger-delegation-v2/swagger.json Logs out the current user from the system. ```APIDOC ## GET /authentication/logout ### Description Terminates the current user session. ### Method GET ### Endpoint /authentication/logout ``` -------------------------------- ### Welcome Message Model Source: https://docs.linshare.org/swagger-admin-v5/swagger.json Defines the structure of a Welcome Message resource in LinShare. ```APIDOC ## Welcome Message Model ### Description Represents a welcome message configuration within a domain. ### Properties - **description** (string) - Welcome message's description (updatable) - **modificationDate** (string, date-time) - Welcome message's modification date - **domain** (object) - Reference to the associated Domain - **assignedToCurrentDomain** (boolean) - Is welcome message assigned to current domain - **readOnly** (boolean) - Is welcome message read only - **entries** (object) - Welcome message entries (updatable) ``` -------------------------------- ### GET /authentication/authorized Source: https://docs.linshare.org/swagger-delegation-v2 Check if the current user is authorized. ```APIDOC ## GET /authentication/authorized ### Description Check if user is authorized. ### Method GET ### Endpoint /authentication/authorized ``` -------------------------------- ### Server Schemas Source: https://docs.linshare.org/swagger-admin-v5/swagger.json Definitions for Server, LdapServer, and TwakeServer objects. ```APIDOC ## Server Schema ### Description A base object representing a server connection in Linshare. ### Properties - **uuid** (string) - Server's uuid - **name** (string) - Server's name - **description** (string) - Server's description - **url** (string) - Server's url - **serverType** (string) - Server's type (Enum: LDAP, TWAKE) - **creationDate** (string, date-time) - Server's creation date - **modificationDate** (string, date-time) - Server's modification date ## LdapServer Schema ### Description A specialized server connection for LDAP. ### Properties - **bindDn** (string) - Ldap server's bindDn - **bindPassword** (string) - Ldap server's password ## TwakeServer Schema ### Description A specialized server connection for Twake. ### Properties - **clientId** (string) - clientId used to connect to Twake Console - **clientSecret** (string) - Secret used for clientId ``` -------------------------------- ### GET /upload_request_groups Source: https://docs.linshare.org/swagger-user-v5/swagger.json Find a list of upload request groups. ```APIDOC ## GET /upload_request_groups ### Description Find a list of upload request group. ### Method GET ### Endpoint /upload_request_groups ### Parameters #### Query Parameters - **status** (array) - Optional - Values to filter upload requests by status (DELETED, PURGED, ARCHIVED, CLOSED, ENABLED, CANCELED, CREATED). ### Response #### Success Response (200) - **UploadRequestGroupDto** (array) - Returns an array of upload request group objects. ``` -------------------------------- ### GET /shared_space_members Source: https://docs.linshare.org/swagger-user-v5/swagger.json Retrieves a list of all shared space members. ```APIDOC ## GET /shared_space_members ### Description Find all shared space member. ### Method GET ### Endpoint /shared_space_members ### Response #### Success Response (200) - **Array** (array) - List of SharedSpaceMember objects. ``` -------------------------------- ### Versioning Parameters Source: https://docs.linshare.org/swagger-delegation-v2/swagger.json Defines the parameters for versioning within a shared space. ```APIDOC ## Versioning Parameters Object ### Description Contains settings related to versioning for shared spaces. ### Properties - **enable** (boolean) - Indicates if versioning is enabled. ``` -------------------------------- ### GET /received_shares Source: https://docs.linshare.org/swagger-user-v5/swagger.json Retrieves all received shares for the connected user. ```APIDOC ## GET /received_shares ### Description Find all connected user received shares. ### Method GET ### Endpoint /received_shares ### Response #### Success Response (200) - **Share** (array) - A list of share entries. ``` -------------------------------- ### GET /lists Source: https://docs.linshare.org/swagger-user-v5/swagger.json Retrieves all mailing lists associated with the user. ```APIDOC ## GET /lists ### Description Find all an user mailing lists. ### Method GET ### Endpoint /lists ### Responses #### Success Response (200) - **MailingList** (array) - A list of mailing lists. #### Response Example ```json [ { "uuid": "string", "name": "string" } ] ``` ``` -------------------------------- ### Domain Object (Light) Source: https://docs.linshare.org/swagger-admin-v5/swagger.json Represents a lightweight version of a LinShare domain. ```APIDOC ## Domain Object (Light) ### Description A lightweight representation of a LinShare domain, containing its UUID and name. ### Properties - **uuid** (string) - Domain's uuid - **name** (string) - Domain's name ``` -------------------------------- ### POST /workspaces Source: https://docs.linshare.org/swagger-admin-v5/swagger.json Creates a new domain workspace filter. Requires administrator privileges. ```APIDOC ## POST /workspaces ### Description It allows root administrator to create a new domain workSpace filter. ### Method POST ### Endpoint /workspaces ### Parameters #### Request Body - **WorkSpaceLdapFilter** (object) - Required - The domain workSpace filter to create ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **WorkSpaceLdapFilter** (object) - The created domain workSpace filter #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### GET /{actorUuid}/lists Source: https://docs.linshare.org/swagger-delegation-v2/swagger.json Find all user mailing lists. ```APIDOC ## GET /{actorUuid}/lists ### Description Find all an user mailing lists. ### Method GET ### Endpoint /{actorUuid}/lists ### Parameters #### Path Parameters - **actorUuid** (string) - Required - The actor (user) uuid. ### Response #### Success Response (200) - **MailingList** (array) - A list of mailing lists. ``` -------------------------------- ### POST /contact_lists Source: https://docs.linshare.org/swagger-user-v5 Create a new contact list. ```APIDOC ## POST /contact_lists ### Description Create a contact list. ### Method POST ### Endpoint /contact_lists ``` -------------------------------- ### GET /contact_lists Source: https://docs.linshare.org/swagger-user-v5 Retrieve all contact lists for the current user. ```APIDOC ## GET /contact_lists ### Description Find all an user contact lists. ### Method GET ### Endpoint /contact_lists ``` -------------------------------- ### GET /welcome_messages/{uuid}/domains Source: https://docs.linshare.org/swagger-admin-v5/swagger.json Retrieves the domains associated with a specific welcome message. ```APIDOC ## GET /welcome_messages/{uuid}/domains ### Description It will return the domains associated to this welcome message. ### Method GET ### Endpoint /welcome_messages/{uuid}/domains ### Parameters #### Path Parameters - **uuid** (string) - Required - welcomeMessage's uuid. ### Response #### Success Response (200) - **domains** (array) - List of associated domains. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### POST /domains/{domainUuid}/mime_policy/{uuid}/assign Source: https://docs.linshare.org/swagger-admin-v5/swagger.json Assign a MIME policy to a domain. ```APIDOC ## POST /domains/{domainUuid}/mime_policy/{uuid}/assign ### Description It allows to assign a mime policy to this domain. ### Method POST ### Endpoint /domains/{domainUuid}/mime_policy/{uuid}/assign ### Parameters #### Path Parameters - **domainUuid** (string) - Required - domain's uuid. - **uuid** (string) - Required - mime policy's uuid to assign. ### Response #### Success Response (204) - No content returned. #### Error Response (40X) - **Error** (object) - Error details. ``` -------------------------------- ### GET /documents/{uuid} Source: https://docs.linshare.org/swagger-user-v5 Retrieve details of a specific document. ```APIDOC ## GET /documents/{uuid} ### Description Get a document. ### Method GET ### Endpoint /documents/{uuid} ### Parameters #### Path Parameters - **uuid** (string) - Required - The document UUID ``` -------------------------------- ### GET /{actorUuid}/workgroups Source: https://docs.linshare.org/swagger-delegation-v2 Retrieve all workgroups for a given actor. ```APIDOC ## GET /{actorUuid}/workgroups ### Description Get all workgroups. ### Method GET ### Endpoint /{actorUuid}/workgroups ### Parameters #### Path Parameters - **actorUuid** (string) - Required - The UUID of the actor. ``` -------------------------------- ### POST /guests/search Source: https://docs.linshare.org/swagger-user-v5/swagger.json Search for guests matching a specific pattern. ```APIDOC ## POST /guests/search ### Description Search all guests who match with some pattern. ### Method POST ### Endpoint /guests/search ### Request Body - **Search** (object) - Required - Patterns to search. ### Response #### Success Response (200) - **Guest[]** (array) - List of matching guests. ``` -------------------------------- ### GET /users/autocomplete/{pattern} Source: https://docs.linshare.org/swagger-admin-v5/swagger.json Provides user autocompletion based on a given pattern. It can be filtered by account type and domain. ```APIDOC ## GET /users/autocomplete/{pattern} ### Description Provides user autocompletion based on a given pattern. It can be filtered by account type and domain. ### Method GET ### Endpoint /users/autocomplete/{pattern} ### Parameters #### Path Parameters - **pattern** (string) - Required - Pattern to complete. #### Query Parameters - **accountType** (string) - Optional - Account type to look for. - **domain** (string) - Optional - Domain to look into. ### Response #### Success Response (200) - **Array of UserV5 objects** - Description of the user objects returned. ``` -------------------------------- ### GET /users/{mail} Source: https://docs.linshare.org/swagger-delegation-v2 Find a user by email address. ```APIDOC ## GET /users/{mail} ### Description Find a user. ### Method GET ### Endpoint /users/{mail} ### Parameters #### Path Parameters - **mail** (string) - Required - The email address of the user. ``` -------------------------------- ### GET /{actorUuid}/statistic Source: https://docs.linshare.org/swagger-delegation-v2 Retrieve statistics between two dates. ```APIDOC ## GET /{actorUuid}/statistic ### Description Get Statistic Between two dates. ### Method GET ### Endpoint /{actorUuid}/statistic ### Parameters #### Path Parameters - **actorUuid** (string) - Required - The actor UUID ``` -------------------------------- ### POST /otp Source: https://docs.linshare.org/swagger-upload-request-v5 Creates a one-time password to download an upload request entry. ```APIDOC ## POST /otp ### Description Create a one time password to download an upload request entry. ### Method POST ### Endpoint /otp ``` -------------------------------- ### POST /{actorUuid}/workgroups/{workgroupUuid}/entries/url Source: https://docs.linshare.org/swagger-delegation-v2/swagger.json Create a document from an URL. ```APIDOC ## POST /{actorUuid}/workgroups/{workgroupUuid}/entries/url ### Description Create a document from an URL. ### Method POST ### Endpoint /{actorUuid}/workgroups/{workgroupUuid}/entries/url ### Parameters #### Path Parameters - **actorUuid** (string) - Required - The actor (user) uuid. - **workgroupUuid** (string) - Required - The workgroup uuid. #### Query Parameters - **async** (boolean) - Optional - True to enable asynchronous upload processing (default=false). - **strict** (boolean) - Optional - Strict mode: Raise error if a node with same name already exists (default=false). #### Request Body - **DocumentURL** (object) - Required - The document URL object. ### Response #### Success Response (200) - **Document** (array) - A list of created documents. ``` -------------------------------- ### GET /anonymousurl/{urlUuid} Source: https://docs.linshare.org/swagger-external Finds an anonymous URL by its UUID. ```APIDOC ## GET /anonymousurl/{urlUuid} ### Description Find an anonymous Url. ### Method GET ### Endpoint /anonymousurl/{urlUuid} ``` -------------------------------- ### GET /upload_request_groups/{uuid} Source: https://docs.linshare.org/swagger-user-v5/swagger.json Find an upload request group by its UUID. ```APIDOC ## GET /upload_request_groups/{uuid} ### Description Find an upload request group. ### Method GET ### Endpoint /upload_request_groups/{uuid} ### Parameters #### Path Parameters - **uuid** (string) - Required - Upload request group uuid. ### Response #### Success Response (200) - **UploadRequestGroupDto** (array) - Returns an array of upload request group objects. ``` -------------------------------- ### Welcome Message Assignment Source: https://docs.linshare.org/swagger-admin-v5/swagger.json Defines the structure for assigning a welcome message to a domain. ```APIDOC ## Welcome Message Assign ### Description Used to assign a welcome message to the current domain. ### Request Body - **assign** (boolean) - Required - Assign to current domain ``` -------------------------------- ### GET /statistic Source: https://docs.linshare.org/swagger-user-v5/swagger.json Retrieve statistics for the authenticated account between two dates. ```APIDOC ## GET /statistic ### Description Get Statistic Between two dates of the authenticated account. ### Method GET ### Endpoint /statistic ### Parameters #### Query Parameters - **beginDate** (string) - Optional - begin statistic creation date - **endDate** (string) - Optional - end statistic creation date - **statisticType** (string) - Optional - statistic type (USER_DAILY_STAT, USER_WEEKLY_STAT, USER_MONTHLY_STAT, WORK_GROUP_DAILY_STAT, WORK_GROUP_WEEKLY_STAT, WORK_GROUP_MONTHLY_STAT, DOMAIN_DAILY_STAT, DOMAIN_WEEKLY_STAT, DOMAIN_MONTHLY_STAT) ### Response #### Success Response (200) - **Array** (Statistic) - Returns a list of statistics. ``` -------------------------------- ### POST /jwt Source: https://docs.linshare.org/swagger-user-v5/swagger.json Creates a new JWT permanent token with a mandatory label and optional description. ```APIDOC ## POST /jwt ### Description Create a JWT permanent token designing a mandatory label and an optional description. ### Method POST ### Endpoint /jwt ### Parameters #### Request Body - **PermanentToken** (object) - Required - Permanent token to create from two fields : label (mandatory) and description (optional) ### Response #### Success Response (200) - **Array** (array) - Returns a list of permanent tokens. ``` -------------------------------- ### GET /shared_space_roles/role/{name} Source: https://docs.linshare.org/swagger-user-v5/swagger.json Find a shared space role by its name. ```APIDOC ## GET /shared_space_roles/role/{name} ### Description Find a shared space role by its name. ### Method GET ### Endpoint /shared_space_roles/role/{name} ### Parameters #### Path Parameters - **name** (string) - Required - shared space role name. ### Response #### Success Response (200) - **Array** (SharedSpaceRole) - Returns a list of shared space roles matching the name. ``` -------------------------------- ### POST /{actorUuid}/lists Source: https://docs.linshare.org/swagger-delegation-v2/swagger.json Create a mailing list. ```APIDOC ## POST /{actorUuid}/lists ### Description Create a mailing list. ### Method POST ### Endpoint /{actorUuid}/lists ### Parameters #### Path Parameters - **actorUuid** (string) - Required - The actor (user) uuid. ### Request Body - **MailingList** (object) - Required - The mailing list to create. ``` -------------------------------- ### GET /shared_space_members/{uuid} Source: https://docs.linshare.org/swagger-user-v5/swagger.json Finds a shared space member by UUID. ```APIDOC ## GET /shared_space_members/{uuid} ### Description Find a shared space member. ### Method GET ### Endpoint /shared_space_members/{uuid} ### Parameters #### Path Parameters - **uuid** (string) - Required - shared space member uuid ### Response #### Success Response (200) - **Array** (array) - Returns the list of shared space members. ```