Memos API
  1. AuthService
Memos API
  • AuthService
    • SignIn signs in the user with the given username and password.
      POST
    • SignInWithSSO signs in the user with the given SSO code.
      POST
    • SignOut signs out the user.
      POST
    • SignUp signs up the user with the given username and password.
      POST
    • GetAuthStatus returns the current auth status of the user.
      POST
  • IdentityProviderService
    • ListIdentityProviders lists identity providers.
      GET
    • CreateIdentityProvider creates an identity provider.
      POST
    • UpdateIdentityProvider updates an identity provider.
      PATCH
    • DeleteIdentityProvider deletes an identity provider.
      DELETE
    • GetIdentityProvider gets an identity provider.
      GET
  • InboxService
    • ListInboxes lists inboxes for a user.
      GET
    • UpdateInbox updates an inbox.
      PATCH
    • DeleteInbox deletes an inbox.
      DELETE
  • MarkdownService
    • GetLinkMetadata returns metadata for a given link.
      GET
    • RestoreMarkdownNodes restores the given nodes to markdown content.
      POST
    • StringifyMarkdownNodes stringify the given nodes to plain text content.
      POST
    • ParseMarkdown parses the given markdown content and returns a list of nodes.
      POST
  • MemoService
    • ListMemos lists memos with pagination and filter.
      GET
    • CreateMemo creates a memo.
      POST
    • DeleteMemoReaction deletes a reaction for a memo.
      DELETE
    • UpdateMemo updates a memo.
      PATCH
    • GetMemo gets a memo.
      GET
    • DeleteMemo deletes a memo.
      DELETE
    • ListMemoComments lists comments for a memo.
      GET
    • CreateMemoComment creates a comment for a memo.
      POST
    • ListMemoReactions lists reactions for a memo.
      GET
    • UpsertMemoReaction upserts a reaction for a memo.
      POST
    • ListMemoRelations lists relations for a memo.
      GET
    • SetMemoRelations sets relations for a memo.
      PATCH
    • ListMemoResources lists resources for a memo.
      GET
    • SetMemoResources sets resources for a memo.
      PATCH
    • ListMemos lists memos with pagination and filter.
      GET
    • DeleteMemoTag deletes a tag for a memo.
      DELETE
    • RenameMemoTag renames a tag for a memo.
      PATCH
  • ResourceService
    • ListResources lists all resources.
    • CreateResource creates a new resource.
    • GetResource returns a resource by name.
    • DeleteResource deletes a resource by name.
    • UpdateResource updates a resource.
    • GetResourceBinary returns a resource binary by name.
  • UserService
    • ListUsers returns a list of users.
    • CreateUser creates a new user.
    • ListAllUserStats returns all user stats.
    • GetUserByUsername gets a user by username.
    • GetUser gets a user by name.
    • DeleteUser deletes a user.
    • ListUserAccessTokens returns a list of access tokens for a user.
    • CreateUserAccessToken creates a new access token for a user.
    • DeleteUserAccessToken deletes an access token for a user.
    • GetUserSetting gets the setting of a user.
    • GetUserStats returns the stats of a user.
    • ListShortcuts returns a list of shortcuts for a user.
    • CreateShortcut creates a new shortcut for a user.
    • DeleteShortcut deletes a shortcut for a user.
    • UpdateShortcut updates a shortcut for a user.
    • UpdateUserSetting updates the setting of a user.
    • UpdateUser updates a user.
    • GetUserAvatarBinary gets the avatar of a user.
  • WebhookService
    • ListWebhooks returns a list of webhooks.
    • CreateWebhook creates a new webhook.
    • GetWebhook returns a webhook by id.
    • DeleteWebhook deletes a webhook by id.
    • UpdateWebhook updates a webhook.
  • WorkspaceService
    • GetWorkspaceProfile returns the workspace profile.
  • WorkspaceSettingService
    • GetWorkspaceSetting returns the setting by name.
    • SetWorkspaceSetting updates the setting.
  • ActivityService
    • GetActivity returns the activity with the given id.
  1. AuthService

SignIn signs in the user with the given username and password.

POST
/api/v1/auth/signin

请求参数

Query 参数
username
string 
可选
The username to sign in with.
password
string 
可选
The password to sign in with.
neverExpire
boolean 
可选
Whether the session should never expire.

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/v1/auth/signin'

返回响应

🟢200成功
application/json
A successful response.
Body
name
string 
可选
The name of the user.
Format: users/{id}, id is the system generated auto-incremented id.
role
enum<string> 
可选
枚举值:
ROLE_UNSPECIFIEDHOSTADMINUSER
默认值:
ROLE_UNSPECIFIED
username
string 
可选
email
string 
可选
nickname
string 
可选
avatarUrl
string 
可选
description
string 
可选
password
string 
可选
state
enum<string> 
可选
枚举值:
STATE_UNSPECIFIEDNORMALARCHIVED
默认值:
STATE_UNSPECIFIED
createTime
string <date-time>
只读可选
updateTime
string <date-time>
只读可选
示例
{
    "name": "string",
    "role": "ROLE_UNSPECIFIED",
    "username": "string",
    "email": "string",
    "nickname": "string",
    "avatarUrl": "string",
    "description": "string",
    "password": "string",
    "state": "STATE_UNSPECIFIED",
    "createTime": "2019-08-24T14:15:22Z",
    "updateTime": "2019-08-24T14:15:22Z"
}
🔴500服务器错误
修改于 2025-03-15 17:43:05
下一页
SignInWithSSO signs in the user with the given SSO code.
Built with