Updated on 2024-12-30 GMT+08:00

API Overview

OneAccess provides management, user, and application integration APIs.

Table 1 OneAccess APIs

Type

Subtype

Description

Management APIs

Access credentials

Obtain an access credential.

User management

Create, modify, and delete users, grant permissions to users, and query user information.

Organization management

Create, modify, delete, and query organizations.

Application organization management

Update, delete, add, and query application organizations.

Application account management

Update, disable, enable, delete, add, and query application accounts.

Application role management

Update, delete, add, and query application roles and members.

User APIs

System APIs

Obtain the server time and public key.

Registration

Register using a mobile number and SMS verification code.

Verification Code

Obtain and verify a CAPTCHA code, obtain an international country code, and send an SMS verification code.

Login and Logout

Log in via username/password, SMS verification code, WeChat, or Alipay, and log out.

Social Media Accounts

Register and log in to a social media account, bind/unbind a mobile number, and list the bound social media accounts.

Password Management

Skip password change when the password is about to expire or has expired, check personal password settings, and reset the password using a mobile number.

MFA

Obtain the mobile number using state_Token and complete authentication via SMS verification code.

Personal Information Management

Query and modify personal information, including the mobile number.

SSO

Obtain sso_ticket with session_token, obtain user information with sso_ticket, and refresh session_token.

ID Token Management

Generate id_token using session_token.

Application integration APIs

CAS-based application authentication

Log in, validate tickets, and log out.

SAML 2.0-based application authentication

Obtain identity provider metadata and perform IdP-initiated SSO.

OAuth2.0-based application authentication

Log in to obtain an authorization code, obtain an access token, and query user information.

OIDC-based application authentication

Perform implicit grant, log in to obtain an authorization code, obtain an ID token, and refresh the access token.

Logout

Log out of sessions to exit all applications.