あなたのアカウント
このグループのすべてのオペレーションの、受け付ける内容、返す内容、返しうるエラー。
オペレーション
The account of the person behind the key or the app: which email notifications they get, their profile photo and username, the apps they connected and the invitations waiting for them. These calls act on a person, never on a workspace: an API key acts for the workspace owner, and an app for the person who connected it. Reading needs account:read and every change needs account:write. Neither is ever limited by a role, so an app a member connected reaches the member's own account too.
/account/notifications/account/notifications/email/{category}/account/notifications/push/{workspaceId}/account/photo/account/photo/account/username/account/username/account/username/availability/account/connected-apps/account/connected-apps/{clientId}/account/invitations/account/invitations/{invitationId}/accept/account/invitations/{invitationId}/decline
GET/account/notifications
Read your notification settings
Which kinds of email OpenEmail sends the person, as Account, Notifications shows them, and the workspaces whose notifications are muted on their phone. Account and billing email cannot be turned off.
Requires the account:read scope.
戻り値
The notification settings.
エラー
どのオペレーションも返しうるエラー400401403404422500エラー一覧
ほかの提供先
PUT/account/notifications/email/{category}
Turn a kind of email on or off
enabled: false stops OpenEmail sending the person that kind of email, and true starts it again. account and billing cannot be turned off, and asking to is a 422 invalid_parameter on category.
Requires the account:write scope.
パスパラメーター
categorystring必須The kind of email.
次のいずれか"account""billing""activity""product"
リクエストボディ
enabledboolean必須True to receive that email, false to stop it.
戻り値
The notification settings as they are now.
エラー
どのオペレーションも返しうるエラー400401403404422500エラー一覧
ほかの提供先
PUT/account/notifications/push/{workspaceId}
Mute a workspace on your phone
muted: true stops the phone app notifying the person about the mail of one workspace, and false lets it notify them again. It applies to every phone they signed in on. A workspace they cannot open is a 404.
Requires the account:write scope.
パスパラメーター
workspaceIdstring必須A workspace from
GET /workspaces.
リクエストボディ
mutedboolean必須True to mute it, false to let it notify again.
戻り値
The notification settings as they are now.
エラー
どのオペレーションも返しうるエラー400401403404422500エラー一覧
ほかの提供先
PUT/account/photo
Set your profile photo
Uploads the person's profile photo, replacing any there was, as Account, Profile does. Send the image itself as the body, not JSON, with its type in Content-Type: image/png, image/jpeg, image/webp, image/gif. Up to 5 MB goes in. It is fitted into a 512 pixel square and stored as WebP, and an animated image keeps its first frame.
Requires the account:write scope.
リクエストボディ
コンテンツタイプimage/png, image/jpeg, image/webp, image/gif
戻り値
The photo, with its new url.
エラー
- 422
invalid_imagewhen the body is not an image of an accepted type, is too large or cannot be read.- 502
image_not_stored: the image was read but could not be stored. Try again.- 503
image_busy: the image service is saturated. Try again shortly.
どのオペレーションも返しうるエラー400401403404500エラー一覧
ほかの提供先
DELETE/account/photo
Remove your profile photo
Removes the profile photo and deletes the stored image, so the app shows initials again. Removing it when there is none changes nothing.
Requires the account:write scope.
戻り値
Removed, with url null.
エラー
どのオペレーションも返しうるエラー400401403404422500エラー一覧
ほかの提供先
GET/account/username
Read your username
PUT/account/username
Choose your username
Sets the username for good, and with it the free address. Once chosen it never changes: a second choice is a 409 username_locked. A username another account has is a 409 username_taken, and one that is too short, too long, reserved or not lowercase letters, numbers and single dots is a 422 invalid_parameter on username. Check one first with GET /account/username/availability.
Requires the account:write scope.
リクエストボディ
usernamestring必須- 60文字まで
戻り値
The username, now chosen.
エラー
- 409
username_locked: the username was chosen before and never changes.username_taken: another account has it.
どのオペレーションも返しうるエラー400401403404422500エラー一覧
ほかの提供先
GET/account/username/availability
Check a username
Whether the person could choose a username, without choosing it. The answer says why when they could not.
Requires the account:read scope.
クエリパラメーター
usernamestring必須The username to check. It is lowercased and its spaces become dots before it is checked, as the app does.
1〜60文字
戻り値
The verdict.
エラー
どのオペレーションも返しうるエラー400401403404422500エラー一覧
ほかの提供先
GET/account/connected-apps
List your connected apps
Every app the person connected with OAuth, as Account, Connected apps lists them: what each may reach, until when, how many tokens it holds and whether changes are allowed without a code for it right now. current marks the app making the call. Changing what an app may reach is done in the app, never through an app.
Requires the account:read scope.
戻り値
The connected apps.
エラー
どのオペレーションも返しうるエラー400401403404422500エラー一覧
ほかの提供先
DELETE/account/connected-apps/{clientId}
Remove a connected app
Deletes every token the app holds and the access the person gave it, so its next call is refused and it has to ask again. Removing the app making the call disconnects it. An app the person never connected is a 404.
Requires the account:write scope.
パスパラメーター
clientIdstring必須The app's
clientIdfromGET /account/connected-apps.
戻り値
Removed.
エラー
どのオペレーションも返しうるエラー400401403404422500エラー一覧
ほかの提供先
GET/account/invitations
List your invitations
The invitations to join a workspace waiting for the address the person signs in with, oldest first. Expired, accepted and withdrawn ones are left out.
Requires the account:read scope.
戻り値
The invitations.
エラー
どのオペレーションも返しうるエラー400401403404422500エラー一覧
ほかの提供先
POST/account/invitations/{invitationId}/accept
Accept an invitation
Joins the workspace with the role and the addresses the invitation gives, as accepting it in the app or from its link does. activate: true also makes it the workspace the app opens. A workspace that asks for two-factor sign-in is a 403 two_factor_required until the person turns it on, and an invitation that expired, was withdrawn or went to another address is a 422.
Requires the account:write scope.
パスパラメーター
invitationIdstring必須The invitation id from
GET /account/invitations.
リクエストボディ
activateboolean
戻り値
Joined.
エラー
- 403
two_factor_required: the workspace asks everyone in it to sign in with two-factor authentication.mailbox_login: a password sign-in for one address cannot join a workspace.
どのオペレーションも返しうるエラー400401404422500エラー一覧
ほかの提供先
POST/account/invitations/{invitationId}/decline
Decline an invitation
Turns the invitation down, so its link stops working, and tells whoever sent it. It cannot be taken back: they have to invite the person again. An invitation they already accepted is a 409 invitation_accepted.
Requires the account:write scope.
パスパラメーター
invitationIdstring必須The invitation id from
GET /account/invitations.
戻り値
Declined.
エラー
どのオペレーションも返しうるエラー400401403404422500エラー一覧
ほかの提供先
オブジェクト
AcceptedInvitationobject
objectstring必須- 次のいずれか
"invitation" idstring必須acceptedboolean必須- 次のいずれか
true workspaceIdstring必須workspaceNamestring必須addressesGrantedinteger必須- 0以上
domainsGrantedinteger必須- 0以上
activatedboolean必須Whether the app now opens the workspace, after
activate: true.
AccountPhotoobject
objectstring必須- 次のいずれか
"account_photo" urlstring必須- null も可
ConnectedAppobject
objectstring必須- 次のいずれか
"connected_app" clientIdstring必須namestring必須- null も可
kindstring必須clifor a sign-in of the command line tool,appfor every other app.次のいずれか"app""cli"cliDevicestring- null も可
currentboolean必須Whether it is the app making this call.
registeredByAccountbooleanredirectUrisstring[]connectedAtstring- null も可形式
date-time accessUntilstringWhen its last token runs out.
null も可形式date-timetokenCountinteger必須- 0以上
statusstring必須- 次のいずれか
"active""expired""needs-approval""access-lost" usablePermissionsintegerHow many of the permissions it was given the person still holds.
null も可elevatedUntilstringUntil when it may make changes that ask for a verification code without one.
null も可形式date-timegrantobjectWhat the person gave it, or null for an app that has to ask again.
null も可workspaceIdstring必須The one workspace the app acts for.
workspaceNamestring必須- null も可
permissionsstring[]必須addressAllowliststring[]必須- null も可
domainAllowliststring[]必須- null も可
expiresAtstring必須When the access ends, or null when it lasts until it is removed.
null も可形式date-timeupdatedAtstring必須- 形式
date-time
ConnectedAppListobject
objectstring- 次のいずれか
"list" dataConnectedApp[]
DeclinedInvitationobject
objectstring必須- 次のいずれか
"invitation" idstring必須declinedboolean必須- 次のいずれか
true
EmailNotificationSettingobject
categorystring必須- 次のいずれか
"account""billing""activity""product" labelstring必須descriptionstring必須requiredboolean必須Whether it can never be turned off.
enabledboolean必須
NotificationSettingsobject
objectstring必須- 次のいずれか
"notification_settings" emailEmailNotificationSetting[]必須Every kind of email OpenEmail sends.
mutedWorkspacesstring[]必須The workspaces whose notifications are muted on the phone.
ReceivedInvitationobject
objectstring必須- 次のいずれか
"invitation" idstring必須workspaceIdstring必須workspaceNamestring必須roleNamestring必須inviterNamestring- null も可
addressesinteger必須How many addresses and whole domains it gives.
0以上expiresAtstring必須- 形式
date-time createdAtstring必須- 形式
date-time
ReceivedInvitationListobject
objectstring- 次のいずれか
"list"
RevokedConnectedAppobject
objectstring必須- 次のいずれか
"connected_app" clientIdstring必須revokedboolean必須- 次のいずれか
true tokensRevokedinteger必須- 0以上
Usernameobject
objectstring必須- 次のいずれか
"username" usernamestring必須- null も可
chosenboolean必須Whether the person chose it. A chosen username never changes.
addressstring必須The free address the username gives, when this deployment offers one.
null も可
UsernameAvailabilityobject
objectstring必須- 次のいずれか
"username_availability" usernamestring必須The username as it was checked.
statusstring必須currentwhen it is the username the person already has.次のいずれか"available""current""taken""reserved""invalid""too_short""too_long"availableboolean必須messagestring必須