Skip to main content

OAuth

warning

This API is not documented yet.

Overview​

Interface for Synology OAuth API.

Provides methods to interact with OAuth clients, tokens, and logs.

Methods​

clients​

Retrieve the list of OAuth clients.

Internal API​

SYNO.OAUTH.Client

Parameters​

offset int
The starting index of the client list. Default is 0.

limit int
The maximum number of clients to retrieve. Default is 20.

Returns​

dict[str, object] or str
The API response containing the list of clients or an error message.


tokens​

Retrieve the list of OAuth tokens.

Internal API​

SYNO.OAUTH.Token

Parameters​

offset int
The starting index of the token list. Default is 0.

limit int
The maximum number of tokens to retrieve. Default is 20.

Returns​

dict[str, object] or str
The API response containing the list of tokens or an error message.


logs​

Retrieve the list of OAuth logs.

Internal API​

SYNO.OAUTH.Log

Parameters​

offset int
The starting index of the log list. Default is 0.

limit int
The maximum number of logs to retrieve. Default is 20.

Returns​

dict[str, object] or str
The API response containing the list of logs or an error message.