summary:SignIn signs in the user with the given username and password.
summary:SignIn signs in the user.
operationId:AuthService_SignIn
responses:
"200":
@ -33,53 +33,37 @@ paths:
schema:
$ref:'#/definitions/googlerpcStatus'
parameters:
- name:username
- name:passwordCredentials.username
description:The username to sign in with.
in:query
required:false
type:string
- name:password
- name:passwordCredentials.password
description:The password to sign in with.
in:query
required:false
type:string
- name:neverExpire
description:Whether the session should never expire.
in:query
required:false
type:boolean
tags:
- AuthService
/api/v1/auth/signin/sso:
post:
summary:SignInWithSSO signs in the user with the given SSO code.
operationId:AuthService_SignInWithSSO
responses:
"200":
description:A successful response.
schema:
$ref:'#/definitions/v1User'
default:
description:An unexpected error response.
schema:
$ref:'#/definitions/googlerpcStatus'
parameters:
- name:idpId
- name:ssoCredentials.idpId
description:The ID of the SSO provider.
in:query
required:false
type:integer
format:int32
- name:code
- name:ssoCredentials.code
description:The code to sign in with.
in:query
required:false
type:string
- name:redirectUri
- name:ssoCredentials.redirectUri
description:The redirect URI.
in:query
required:false
type:string
- name:neverExpire
description:Whether the session should never expire.
in:query
required:false
type:boolean
tags:
- AuthService
/api/v1/auth/signout:
@ -305,7 +289,9 @@ paths:
$ref:'#/definitions/googlerpcStatus'
parameters:
- name:parent
description:"The parent is the owner of the memos.\r\nIf not specified or `users/-`, it will list all memos."
description:|-
The parent is the owner of the memos.
If not specified or `users/-`, it will list all memos.
in:query
required:false
type:string
@ -316,12 +302,16 @@ paths:
type:integer
format:int32
- name:pageToken
description:"A page token, received from a previous `ListMemos` call.\r\nProvide this to retrieve the subsequent page."
description:|-
A page token, received from a previous `ListMemos` call.
Provide this to retrieve the subsequent page.
in:query
required:false
type:string
- name:state
description:"The state of the memos to list.\r\nDefault to `NORMAL`. Set to `ARCHIVED` to list archived memos."
description:|-
The state of the memos to list.
Default to `NORMAL`. Set to `ARCHIVED` to list archived memos.
in:query
required:false
type:string
@ -331,12 +321,16 @@ paths:
- ARCHIVED
default:STATE_UNSPECIFIED
- name:sort
description:"What field to sort the results by.\r\nDefault to display_time."
description:|-
What field to sort the results by.
Default to display_time.
in:query
required:false
type:string
- name:direction
description:"The direction to sort the results by.\r\nDefault to DESC."
description:|-
The direction to sort the results by.
Default to DESC.
in:query
required:false
type:string
@ -346,12 +340,16 @@ paths:
- DESC
default:DIRECTION_UNSPECIFIED
- name:filter
description:"Filter is a CEL expression to filter memos.\r\nRefer to `Shortcut.filter`."
description:|-
Filter is a CEL expression to filter memos.
Refer to `Shortcut.filter`.
in:query
required:false
type:string
- name:oldFilter
description:"[Deprecated] Old filter contains some specific conditions to filter memos.\r\nFormat: \"creator == 'users/{user}' && visibilities == ['PUBLIC', 'PROTECTED']\""
description:|-
[Deprecated] Old filter contains some specific conditions to filter memos.
description:"The id of the reaction.\r\nRefer to the `Reaction.id`."
description:|-
The id of the reaction.
Refer to the `Reaction.id`.
in:path
required:true
type:integer
@ -662,7 +662,9 @@ paths:
$ref:'#/definitions/googlerpcStatus'
parameters:
- name:name
description:"The resource name of the workspace setting.\r\nFormat: settings/{setting}"
description:|-
The resource name of the workspace setting.
Format:settings/{setting}
in:path
required:true
type:string
@ -684,7 +686,9 @@ paths:
$ref:'#/definitions/googlerpcStatus'
parameters:
- name:setting.name
description:"name is the name of the setting.\r\nFormat: settings/{setting}"
description:|-
name is the name of the setting.
Format:settings/{setting}
in:path
required:true
type:string
@ -806,13 +810,17 @@ paths:
$ref:'#/definitions/googlerpcStatus'
parameters:
- name:memo.name
description:"The name of the memo.\r\nFormat: memos/{memo}, memo is the user defined id or uuid."
description:|-
The name of the memo.
Format:memos/{memo}, memo is the user defined id or uuid.
in:path
required:true
type:string
pattern:memos/[^/]+
- name:memo
description:"The memo to update.\r\nThe `name` field is required."
description:|-
The memo to update.
The `name` field is required.
in:body
required:true
schema:
@ -822,7 +830,9 @@ paths:
$ref:'#/definitions/v1State'
creator:
type:string
title:"The name of the creator.\r\nFormat: users/{user}"
title:|-
The name of the creator.
Format:users/{user}
createTime:
type:string
format:date-time
@ -870,7 +880,9 @@ paths:
readOnly:true
parent:
type:string
title:"The name of the parent memo.\r\nFormat: memos/{id}"
title:|-
The name of the parent memo.
Format:memos/{id}
readOnly:true
snippet:
type:string
@ -879,7 +891,9 @@ paths:
location:
$ref:'#/definitions/apiv1Location'
description:The location of the memo.
title:"The memo to update.\r\nThe `name` field is required."
title:|-
The memo to update.
The `name` field is required.
required:
- memo
tags:
@ -1075,7 +1089,9 @@ paths:
$ref:'#/definitions/googlerpcStatus'
parameters:
- name:name
description:"The name of the activity.\r\nFormat: activities/{id}, id is the system generated auto-incremented id."
description:|-
The name of the activity.
Format:activities/{id}, id is the system generated auto-incremented id.
in:path
required:true
type:string
@ -1434,7 +1450,9 @@ paths:
$ref:'#/definitions/googlerpcStatus'
parameters:
- name:parent
description:"The parent is the owner of the memos.\r\nIf not specified or `users/-`, it will list all memos."
description:|-
The parent is the owner of the memos.
If not specified or `users/-`, it will list all memos.
in:path
required:true
type:string
@ -1446,12 +1464,16 @@ paths:
type:integer
format:int32
- name:pageToken
description:"A page token, received from a previous `ListMemos` call.\r\nProvide this to retrieve the subsequent page."
description:|-
A page token, received from a previous `ListMemos` call.
Provide this to retrieve the subsequent page.
in:query
required:false
type:string
- name:state
description:"The state of the memos to list.\r\nDefault to `NORMAL`. Set to `ARCHIVED` to list archived memos."
description:|-
The state of the memos to list.
Default to `NORMAL`. Set to `ARCHIVED` to list archived memos.
in:query
required:false
type:string
@ -1461,12 +1483,16 @@ paths:
- ARCHIVED
default:STATE_UNSPECIFIED
- name:sort
description:"What field to sort the results by.\r\nDefault to display_time."
description:|-
What field to sort the results by.
Default to display_time.
in:query
required:false
type:string
- name:direction
description:"The direction to sort the results by.\r\nDefault to DESC."
description:|-
The direction to sort the results by.
Default to DESC.
in:query
required:false
type:string
@ -1476,12 +1502,16 @@ paths:
- DESC
default:DIRECTION_UNSPECIFIED
- name:filter
description:"Filter is a CEL expression to filter memos.\r\nRefer to `Shortcut.filter`."
description:|-
Filter is a CEL expression to filter memos.
Refer to `Shortcut.filter`.
in:query
required:false
type:string
- name:oldFilter
description:"[Deprecated] Old filter contains some specific conditions to filter memos.\r\nFormat: \"creator == 'users/{user}' && visibilities == ['PUBLIC', 'PROTECTED']\""
description:|-
[Deprecated] Old filter contains some specific conditions to filter memos.
description:"The parent, who owns the tags.\r\nFormat: memos/{id}. Use \"memos/-\" to delete all tags."
description:|-
The parent, who owns the tags.
Format:memos/{id}. Use "memos/-" to delete all tags.
in:path
required:true
type:string
@ -1650,7 +1682,9 @@ paths:
$ref:'#/definitions/googlerpcStatus'
parameters:
- name:parent
description:"The parent, who owns the tags.\r\nFormat: memos/{id}. Use \"memos/-\" to rename all tags."
description:|-
The parent, who owns the tags.
Format:memos/{id}. Use "memos/-" to rename all tags.
in:path
required:true
type:string
@ -1677,7 +1711,9 @@ paths:
$ref:'#/definitions/googlerpcStatus'
parameters:
- name:resource.name
description:"The name of the resource.\r\nFormat: resources/{resource}, resource is the user defined if or uuid."
description:|-
The name of the resource.
Format:resources/{resource}, resource is the user defined if or uuid.
in:path
required:true
type:string
@ -1763,7 +1799,9 @@ paths:
$ref:'#/definitions/googlerpcStatus'
parameters:
- name:user.name
description:"The name of the user.\r\nFormat: users/{id}, id is the system generated auto-incremented id."
description:|-
The name of the user.
Format:users/{id}, id is the system generated auto-incremented id.
in:path
required:true
type:string
@ -2026,7 +2064,9 @@ definitions:
properties:
memo:
type:string
description:"The memo name of comment.\r\nRefer to `Memo.name`."
description:|-
The memo name of comment.
Refer to `Memo.name`.
relatedMemo:
type:string
description:The name of related memo.
@ -2090,13 +2130,17 @@ definitions:
properties:
name:
type:string
description:"The name of the memo.\r\nFormat: memos/{memo}, memo is the user defined id or uuid."
description:|-
The name of the memo.
Format:memos/{memo}, memo is the user defined id or uuid.
readOnly:true
state:
$ref:'#/definitions/v1State'
creator:
type:string
title:"The name of the creator.\r\nFormat: users/{user}"
title:|-
The name of the creator.
Format:users/{user}
createTime:
type:string
format:date-time
@ -2144,7 +2188,9 @@ definitions:
readOnly:true
parent:
type:string
title:"The name of the parent memo.\r\nFormat: memos/{id}"
title:|-
The name of the parent memo.
Format:memos/{id}
readOnly:true
snippet:
type:string
@ -2230,7 +2276,10 @@ definitions:
weekStartDayOffset:
type:integer
format:int32
description:"week_start_day_offset is the week start day offset from Sunday.\r\n0: Sunday, 1: Monday, 2: Tuesday, 3: Wednesday, 4: Thursday, 5: Friday, 6: Saturday\r\nDefault is Sunday."
description:|-
week_start_day_offset is the week start day offset from Sunday.
title:"name is the name of the setting.\r\nFormat: settings/{setting}"
title:|-
name is the name of the setting.
Format:settings/{setting}
generalSetting:
$ref:'#/definitions/apiv1WorkspaceGeneralSetting'
storageSetting:
@ -2298,7 +2349,9 @@ definitions:
description:storage_type is the storage type.
filepathTemplate:
type:string
title:"The template of file path.\r\ne.g. assets/{timestamp}_{filename}"
title:|-
The template of file path.
e.g. assets/{timestamp}_{filename}
uploadSizeLimitMb:
type:string
format:int64
@ -2457,11 +2510,15 @@ definitions:
properties:
name:
type:string
title:"The name of the activity.\r\nFormat: activities/{id}"
title:|-
The name of the activity.
Format:activities/{id}
readOnly:true
creator:
type:string
title:"The name of the creator.\r\nFormat: users/{user}"
title:|-
The name of the creator.
Format:users/{user}
type:
type:string
description:The type of the activity.
@ -2723,7 +2780,9 @@ definitions:
$ref:'#/definitions/apiv1Memo'
nextPageToken:
type:string
description:"A token, which can be sent as `page_token` to retrieve the next page.\r\nIf this field is omitted, there are no subsequent pages."
description:|-
A token, which can be sent as `page_token` to retrieve the next page.
If this field is omitted, there are no subsequent pages.
v1ListNode:
type:object
properties:
@ -2812,7 +2871,9 @@ definitions:
properties:
name:
type:string
title:"The name of the memo.\r\nFormat: memos/{id}"
title:|-
The name of the memo.
Format:memos/{id}
uid:
type:string
snippet:
@ -2968,6 +3029,15 @@ definitions:
items:
type:object
$ref:'#/definitions/v1Node'
v1PasswordCredentials:
type:object
properties:
username:
type:string
description:The username to sign in with.
password:
type:string
description:The password to sign in with.
v1Reaction:
type:object
properties:
@ -2998,7 +3068,9 @@ definitions:
properties:
name:
type:string
description:"The name of the resource.\r\nFormat: resources/{resource}, resource is the user defined if or uuid."
description:|-
The name of the resource.
Format:resources/{resource}, resource is the user defined if or uuid.
readOnly:true
createTime:
type:string
@ -3032,6 +3104,19 @@ definitions:
properties:
markdown:
type:string
v1SSOCredentials:
type:object
properties:
idpId:
type:integer
format:int32
description:The ID of the SSO provider.
code:
type:string
description:The code to sign in with.
redirectUri:
type:string
description:The redirect URI.
v1SpoilerNode:
type:object
properties:
@ -3132,7 +3217,9 @@ definitions:
properties:
name:
type:string
description:"The name of the user.\r\nFormat: users/{id}, id is the system generated auto-incremented id."
description:|-
The name of the user.
Format:users/{id}, id is the system generated auto-incremented id.
readOnly:true
role:
$ref:'#/definitions/UserRole'
@ -3182,7 +3269,9 @@ definitions:
items:
type:string
format:date-time
description:"The timestamps when the memos were displayed.\r\nWe should return raw data to the client, and let the client format the data with the user's timezone."
description:|-
The timestamps when the memos were displayed.
We should return raw data to the client, and let the client format the data with the user's timezone.
memoTypeStats:
$ref:'#/definitions/UserStatsMemoTypeStats'
description:The stats of memo types.
@ -3191,7 +3280,9 @@ definitions:
additionalProperties:
type:integer
format:int32
title:"The count of tags.\r\nFormat: \"tag1\": 1, \"tag2\": 2"