Download OpenAPI specification:
Search users by name or email with pagination
| name required | string User name or email to search |
| limit | integer Limit results (default: 10) |
| offset | integer Offset for pagination (default: 0) |
{- "body": { },
- "error": { },
- "status": "string",
- "data": {
- "users": [
- {
- "applications": [
- {
- "id": 0,
- "name": "string",
- "roles": [
- {
- "id": 0,
- "name": "string"
}
]
}
], - "avatar": "string",
- "bindings": [
- {
- "login_type": "string",
- "mail": "string"
}
], - "id": 0,
- "name": "string"
}
]
}
}Set the default role for a specific application
Set default role request
| app_id required | integer |
| role_id required | integer |
{- "app_id": 0,
- "role_id": 0
}{- "body": { },
- "error": {
- "code": 0,
- "message": null
}, - "status": "string"
}Update the internationalized names for a specific application
Update i18n name request
| app_id required | integer |
Array of objects (request.ApplicationI18nName) |
{- "app_id": 0,
- "i18n_names": [
- {
- "i18n_name": "string",
- "tag": "string"
}
]
}{- "body": { },
- "error": {
- "code": 0,
- "message": null
}, - "status": "string"
}Create a new role with the specified name in an application
Role creation request
| app_id required | integer |
| name required | string |
{- "app_id": 0,
- "name": "string"
}{- "body": { },
- "error": {
- "code": 0,
- "message": null
}, - "status": "string"
}Update the scopes associated with a role
Role scope update request
| role_id required | integer |
| scopes required | Array of integers non-empty |
{- "role_id": 0,
- "scopes": [
- 0
]
}{- "body": { },
- "error": {
- "code": 0,
- "message": null
}, - "status": "string"
}Set the default scope for a specific role
Set default scope request
| role_id required | integer |
| scope_id required | integer |
{- "role_id": 0,
- "scope_id": 0
}{- "body": { },
- "error": {
- "code": 0,
- "message": null
}, - "status": "string"
}Create a new scope with the specified name in an application
Scope creation request
| app_id required | integer |
| name required | string |
{- "app_id": 0,
- "name": "string"
}{- "body": { },
- "error": {
- "code": 0,
- "message": null
}, - "status": "string"
}Update or set a user's role in a specific application
Update user role request
| app_id required | integer |
| role_id required | integer |
| user_id required | integer |
{- "app_id": 0,
- "role_id": 0,
- "user_id": 0
}{- "body": { },
- "error": {
- "code": 0,
- "message": null
}, - "status": "string"
}Get Apple login information
| app_name required | string Application name |
{- "body": { },
- "error": { },
- "status": "string",
- "data": {
- "apple_bundle_id": "string",
- "apple_client_id": "string",
- "apple_key_id": "string",
- "apple_p8_cert_content": "string",
- "apple_redirect_url": "string",
- "apple_team_id": "string"
}
}Update Apple login information
Apple login information
| app_id required | integer Application ID in the pluto system |
| bundle_id required | string |
| client_id required | string |
| key_id required | string |
| p8_cert_content required | string Base64 encoded content of the .p8 certificate file |
| redirect_url | string |
| team_id required | string |
{- "app_id": 0,
- "bundle_id": "string",
- "client_id": "string",
- "key_id": "string",
- "p8_cert_content": "string",
- "redirect_url": "string",
- "team_id": "string"
}{- "body": { },
- "error": {
- "code": 0,
- "message": null
}, - "status": "string"
}Create a new application with specified details
Application creation request
| name required | string |
{- "name": "string"
}{- "body": { },
- "error": { },
- "status": "string",
- "data": {
- "default_role": 0,
- "id": 0,
- "name": "string",
- "webhook": "string"
}
}Update Google login information
Google login information
| app_id required | integer Application ID in the pluto system |
| aud required | string Google OAuth client ID |
{- "app_id": 0,
- "aud": "string"
}{- "body": { },
- "error": {
- "code": 0,
- "message": null
}, - "status": "string"
}Get all internationalized names for the specified application
| app_id required | integer Application ID |
{- "body": { },
- "error": { },
- "status": "string",
- "data": {
- "app_id": 0,
- "app_name": "string",
- "i18n_names": [
- {
- "i18n_name": "string",
- "tag": "string"
}
]
}
}Get WeChat login information
| app_name required | string Application name |
{- "body": { },
- "error": { },
- "status": "string",
- "data": {
- "wechat_app_id": "string",
- "wechat_app_secret": "string",
- "wechat_web_id": "string",
- "wechat_web_secret": "string"
}
}Update WeChat login information
Wechat login information
| app_id required | integer Application ID in the pluto system |
| wechat_app_id | string Mobile app configuration |
| wechat_app_secret | string |
| wechat_web_id | string Web app configuration |
| wechat_web_secret | string |
{- "app_id": 0,
- "wechat_app_id": "string",
- "wechat_app_secret": "string",
- "wechat_web_id": "string",
- "wechat_web_secret": "string"
}{- "body": { },
- "error": {
- "code": 0,
- "message": null
}, - "status": "string"
}Get a list of all roles for the specified application
| app_id required | integer Application ID |
{- "body": { },
- "error": { },
- "status": "string",
- "data": {
- "application": {
- "default_role": 0,
- "id": 0,
- "name": "string",
- "webhook": "string"
}, - "roles": [
- {
- "application": 0,
- "created_at": "string",
- "id": 0,
- "name": "string",
- "updated_at": "string"
}
]
}
}Get a list of all scopes for the specified application
| app_id required | integer Application ID |
{- "body": { },
- "error": { },
- "status": "string",
- "data": {
- "application": {
- "default_role": 0,
- "id": 0,
- "name": "string",
- "webhook": "string"
}, - "scopes": [
- {
- "application": 0,
- "created_at": "string",
- "id": 0,
- "name": "string",
- "updated_at": "string"
}
]
}
}Create a new OAuth client application
OAuth client creation request
| key required | string [ 1 .. 100 ] characters |
| redirect_uri required | string |
| secret required | string [ 6 .. 128 ] characters |
{- "key": "string",
- "redirect_uri": "string",
- "secret": "string"
}{- "body": { },
- "error": { },
- "status": "string",
- "data": {
- "key": "string",
- "origin_secret": "string",
- "redirect_uri": "string",
- "status": "string"
}
}Approve or reject an OAuth client application
OAuth client status update request
| key required | string [ 1 .. 100 ] characters |
| status required | string Enum: "active" "inactive" |
{- "key": "string",
- "status": "active"
}{- "body": { },
- "error": { },
- "status": "string",
- "data": {
- "key": "string",
- "status": "string"
}
}Login with username/email and password, sets access token cookie and redirects
| login_redirect_uri | string Redirect URI after successful login |
Login credentials
| account required | string |
| app_name required | string |
| device_id | string |
| password required | string |
{- "account": "string",
- "app_name": "string",
- "device_id": "string",
- "password": "string"
}"string"Exchange authorization code, password, client credentials, or refresh token for access tokens
Token exchange request
| app_name required | string |
| clientID | string |
| clientSecret | string |
| code | string |
| device_id | string |
| grant_type required | string Enum: "authorization_code" "password" "client_credentials" "refresh_token" |
| password | string [ 6 .. 128 ] characters |
| redirect_uri | string |
| refresh_token | string |
| scopes | string |
| user | string |
{- "app_name": "string",
- "clientID": "string",
- "clientSecret": "string",
- "code": "string",
- "device_id": "string",
- "grant_type": "authorization_code",
- "password": "string",
- "redirect_uri": "string",
- "refresh_token": "string",
- "scopes": "string",
- "user": "string"
}{- "body": { },
- "error": { },
- "status": "string",
- "data": {
- "access_token": "string",
- "refresh_token": "string",
- "refresh_token_expire_at": 0,
- "type": "string"
}
}Verify access token validity and get token payload
Token verification request
| token required | string |
{- "token": "string"
}{- "body": { },
- "error": { },
- "status": "string",
- "data": {
- "exp": 0,
- "iat": 0,
- "iss": "string",
- "scopes": [
- "string"
], - "sub": 0,
- "type": "string"
}
}Refresh access token using refresh token
Token refresh request
| app_name required | string |
| refresh_token required | string |
| scopes | string |
{- "app_name": "string",
- "refresh_token": "string",
- "scopes": "string"
}{- "body": { },
- "error": { },
- "status": "string",
- "data": {
- "access_token": "string",
- "refresh_token": "string",
- "refresh_token_expire_at": 0,
- "type": "string"
}
}Bind external account (Google, Apple, WeChat, Mail) to current user
Binding request
| code | string |
| id_token | string |
string | |
| type required | string Enum: "mail" "google" "apple" "wechat" |
{- "code": "string",
- "id_token": "string",
- "mail": "string",
- "type": "mail"
}{- "body": { },
- "error": { },
- "status": "string"
}{- "body": { },
- "error": { },
- "status": "string",
- "data": {
- "app_name": "string",
- "avatar": "string",
- "bindings": [
- {
- "login_type": "string",
- "mail": "string"
}
], - "created_at": "string",
- "is_password_set": "string",
- "name": "string",
- "role": "string",
- "sub": 0,
- "updated_at": "string",
- "user_id": "string",
- "user_id_updated": true,
- "verified": "string"
}
}Update authenticated user's profile information
Update user info request
| avatar | string |
| name | string [ 1 .. 100 ] characters |
| user_id | string |
{- "avatar": "string",
- "name": "string",
- "user_id": "string"
}{- "body": { },
- "error": { },
- "status": "string"
}Get public profile information for a specific user by user ID
| userId required | string User ID to retrieve public info for |
{- "body": { },
- "error": { },
- "status": "string",
- "data": {
- "avatar": "string",
- "id": 0,
- "name": "string"
}
}Get public profile information for multiple users by IDs
| ids required | Array of strings User IDs to retrieve public info for |
{- "body": { },
- "error": { },
- "status": "string",
- "data": {
- "users": {
- "property1": {
- "avatar": "string",
- "id": 0,
- "name": "string"
}, - "property2": {
- "avatar": "string",
- "id": 0,
- "name": "string"
}
}
}
}Login with username/email and password
Login credentials
| account required | string |
| app_name required | string |
| device_id | string |
| password required | string |
{- "account": "string",
- "app_name": "string",
- "device_id": "string",
- "password": "string"
}{- "body": { },
- "error": { },
- "status": "string",
- "data": {
- "access_token": "string",
- "refresh_token": "string",
- "refresh_token_expire_at": 0,
- "type": "string"
}
}Login with Apple account for mobile applications
Apple mobile login request
| app_name required | string |
| code required | string |
| device_id | string |
| name | string |
{- "app_name": "string",
- "code": "string",
- "device_id": "string",
- "name": "string"
}{- "body": { },
- "error": { },
- "status": "string",
- "data": {
- "access_token": "string",
- "refresh_token": "string",
- "refresh_token_expire_at": 0,
- "type": "string"
}
}Login with Google account for mobile applications
Google mobile login request
| app_name required | string |
| device_id | string |
| id_token required | string |
{- "app_name": "string",
- "device_id": "string",
- "id_token": "string"
}{- "body": { },
- "error": { },
- "status": "string",
- "data": {
- "access_token": "string",
- "refresh_token": "string",
- "refresh_token_expire_at": 0,
- "type": "string"
}
}Login with WeChat account for mobile applications
WeChat mobile login request
| app_name required | string |
| code required | string |
| device_id | string |
{- "app_name": "string",
- "code": "string",
- "device_id": "string"
}{- "body": { },
- "error": { },
- "status": "string",
- "data": {
- "access_token": "string",
- "refresh_token": "string",
- "refresh_token_expire_at": 0,
- "type": "string"
}
}Send password reset email to user's registered email
Password reset mail request
| app_name required | string |
| mail required | string |
{- "app_name": "string",
- "mail": "string"
}{- "body": { },
- "error": { },
- "status": "string"
}Register a new user
Mail Register Request
| app_name required | string |
| mail required | string |
| name required | string [ 1 .. 100 ] characters |
| password required | string [ 6 .. 128 ] characters |
| user_id | string |
{- "app_name": "string",
- "mail": "string",
- "name": "string",
- "password": "string",
- "user_id": "string"
}{- "body": { },
- "error": { },
- "status": "string",
- "data": {
- "mail": "string",
- "verified": true
}
}Send verification email for user registration
Register verify mail request
| app_name required | string |
string | |
| user_id | string |
{- "app_name": "string",
- "mail": "string",
- "user_id": "string"
}{- "body": { },
- "error": { },
- "status": "string"
}Unbind external account (Google, Apple, WeChat, Mail) from current user
Unbinding request
| type required | string Enum: "mail" "google" "apple" "wechat" |
{- "type": "mail"
}{- "body": { },
- "error": { },
- "status": "string"
}