Moco BaaS - Common Services
 1.6 
OAS3

services.v1.json

Common API for Moco BaaS. Mostly used for Client SDK. Attempt to follow JSON:API v1.0 specification.

Please note that certain operations are not conformant to JSON:API, please check following flag on each description:

  1. [non-standard] implementation doesn't follow JSON:API specification.
  2. [non-resource] implementation is action-oriented, data might not available. Please refer to meta for further information.
Contact Hash Rekayasa Teknologi
ISV
Servers

Authentication

(identityProvider.enabled = false)

GET​/auth
OAuth login initiation
POST​/auth
Login / Verify OAuth
PATCH​/auth
Refresh access
DELETE​/auth
Begin forgot password procedure
PUT​/auth
Reset password
GET​/auth​/account
Check email availability
POST​/auth​/account
Register new account

Email Verification

(identityProvider.enabled = false)

GET​/emailverification
Confirm email ownership
POST​/emailverification
Resend verification email

Authenticated User

(identityProvider.enabled = false)

GET​/me
Current profile
PATCH​/me
Update current profile
DELETE​/me
Logout

Identity Provider Authentication

(identityProvider.enabled = true)

GET​/idp​/auth
OAuth login initiation
POST​/idp​/auth
Verify OAuth
PATCH​/idp​/auth
Refresh access
GET​/idp​/auth​/account
Get ID provider Account URL

Identity Provider Authenticated User

(identityProvider.enabled = true)

GET​/idp​/me
Current profile
POST​/idp​/me
Create local profile
PATCH​/idp​/me
Update local profile
DELETE​/idp​/me
Logout

Storage

GET​/uploadurl
Obtain presigned upload URL
GET​/downloadurl
Obtain presigned download URL

Asynchronous Event

GET​/event
Retrieve event channels
POST​/event
Submit an event

Notification

GET​/notification​/{type}
Available templates
POST​/notification​/email
Send email
POST​/notification​/push
Send push notification

Resource Availability

GET​/availability​/tables​/{table}
Tables Columns that available for access
GET​/availability​/customscript
Custom Script that available for access

Schemas

tables_available
custom_script_available
profile
upload_url
download_url
error
login_existing
login_oauth
userinfo_claims
idp_profile
idp_access
idp_extended_access