# Alibaba Cloud Idaas Auth API

> Alibaba Cloud Idaas Auth API on Apizie: 17 endpoints (Initializes the creation of an authenticator, Initializes authenticator verification, Unregisters an authenticator, Retrieves an application API authorization access token for subsequent authenticator-related API calls, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-idaas-doraemon/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-idaas-doraemon`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/idaas-doraemon
- Page: https://zieapi.vercel.app/api/cloud/aliyun-idaas-doraemon
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-idaas-doraemon/openapi.json

Alibaba Cloud OpenAPI for Idaas Auth (idaas-doraemon, version 2021-05-20). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Initializes the creation of an authenticator
`POST https://zieapi.vercel.app/v1/cloud:aliyun-idaas-doraemon/create-authenticator-registration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://idaas-doraemon.aliyuncs.com |
| ApplicationExternalId | string | yes | The external ID of the application |
| AuthenticatorType | string | yes | The type of the authenticator |
| UserId | string | yes | The ID of the user |
| UserName | string | no | The username |
| UserDisplayName | string | no | The display name of the user |
| ClientExtendParamsJson | string | no | The authentication context generated by the client SDK |
| ClientExtendParamsJsonSign | string | no | The signature information of the authentication context generated by the client SDK |
| ServerExtendParamsJson | string | no | The server configuration item that determines the authentication requirement properties |
| RegistrationContext | string | no | The registration context |

### Initializes authenticator verification
`POST https://zieapi.vercel.app/v1/cloud:aliyun-idaas-doraemon/create-user-authenticate-options` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://idaas-doraemon.aliyuncs.com |
| ApplicationExternalId | string | yes | The external ID of the application |
| AuthenticatorType | string | yes | The type of the authenticator |
| UserId | string | yes | The ID of the user |
| BindHashBase64 | string | no | The operation hash that is used to bind with the authentication |
| ClientExtendParamsJson | string | no | The authentication context generated by the client SDK |
| ClientExtendParamsJsonSign | string | no | The signature information of the authentication context generated by the client SDK |
| ServerExtendParamsJson | string | no | The server configuration item that determines the authentication requirement properties |

### Unregisters an authenticator
`POST https://zieapi.vercel.app/v1/cloud:aliyun-idaas-doraemon/deregister-authenticator` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://idaas-doraemon.aliyuncs.com |
| ApplicationExternalId | string | yes | The external ID of the application |
| UserId | string | yes | The user ID |
| AuthenticatorUuid | string | yes | The UUID of the authenticator |

### Retrieves an application API authorization access token for subsequent authenticator-related API calls
`POST https://zieapi.vercel.app/v1/cloud:aliyun-idaas-doraemon/fetch-access-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://idaas-doraemon.aliyuncs.com |
| MobileExtendParamsJson | string | yes | The client extension JSON parameter. The value is a Base64-encoded JSON string |
| MobileExtendParamsJsonSign | string | yes | The value generated by signing MobileExtendParamsJson with the application secret key. The signing method is HmacSHA256 + Hex |
| ServerExtendParamsJson | string | no | The server extension JSON parameter. The value is a Base64-encoded JSON string |
| ApplicationExternalId | string | yes | The external ID of the application |
| XClientIp | string | no | The client IP address |
| UserId | string | no | The user identifier |

### Retrieves the details of an authenticator
`POST https://zieapi.vercel.app/v1/cloud:aliyun-idaas-doraemon/get-authenticator` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://idaas-doraemon.aliyuncs.com |
| ApplicationExternalId | string | yes | The external ID of the application |
| UserId | string | yes | The user ID |
| AuthenticatorUuid | string | yes | The UUID of the authenticator |

### Queries authenticator operation logs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-idaas-doraemon/list-authenticator-ops-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://idaas-doraemon.aliyuncs.com |
| ApplicationExternalId | string | yes | The external ID of the application |
| UserId | string | no | The user identifier |
| AuthenticatorUuid | string | no | The unique identifier of the authenticator |
| AuthenticatorType | string | no | The authenticator type |
| FromTime | integer | no | The start time of the query range |
| ToTime | integer | no | The end time of the query range |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of records per page |

### Retrieves all authenticators
`POST https://zieapi.vercel.app/v1/cloud:aliyun-idaas-doraemon/list-authenticators` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://idaas-doraemon.aliyuncs.com |
| ApplicationExternalId | string | yes | The external ID of the application |
| UserId | string | yes | The user ID |
| AuthenticatorType | string | no | The type of the authenticator |
| PageNumber | integer | no | The page number to start reading from. Default value: 1 |
| PageSize | integer | no | The maximum number of records to return per page. If not specified, the default value is used |

### Performs a paged query of orders and their compute unit (CU) usage information, sorted by creation time in…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-idaas-doraemon/list-cost-unit-orders` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://idaas-doraemon.aliyuncs.com |
| BeginDate | string | no | The start creation time for filtering orders |
| FinalDate | string | no | The end creation time for filtering orders |
| PageNumber | integer | no | The page number to return |
| PageSize | integer | no | The number of entries per page |

### Queries daily usage statistics records for an order by paging. Results are sorted by statistics date in…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-idaas-doraemon/list-order-consume-statistic-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://idaas-doraemon.aliyuncs.com |
| AliOrderCode | string | no | The Alibaba Cloud order ID |
| StatisticTimeMin | string | no | The minimum statistics date |
| StatisticTimeMax | string | no | The maximum statistics date. Default value: yesterday |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of records per page |
| ApplicationExternalId | string | no | The ApplicationExternalId |
| ServiceCode | string | no | The ServiceCode |

### Detects password leakage
`POST https://zieapi.vercel.app/v1/cloud:aliyun-idaas-doraemon/list-pwned-passwords` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://idaas-doraemon.aliyuncs.com |
| PrefixHexPasswordSha1Hash | string | yes | The first six characters of the SHA1 hash value of the password |

### Queries SMS delivery receipts
`POST https://zieapi.vercel.app/v1/cloud:aliyun-idaas-doraemon/query-sms-reports` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://idaas-doraemon.aliyuncs.com |
| AppId | string | no | The application ID |
| EventId | string | no | The event ID |

### Registers an authenticator
`POST https://zieapi.vercel.app/v1/cloud:aliyun-idaas-doraemon/register-authenticator` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://idaas-doraemon.aliyuncs.com |
| ApplicationExternalId | string | yes | The external ID of the application |
| AuthenticatorType | string | yes | The type of the authenticator |
| UserId | string | yes | The user ID |
| AuthenticatorName | string | no | The name of the authenticator |
| RegistrationContext | string | yes | The registration context |
| RequireChallengeBase64 | string | no | The Base64-encoded challenge identifier bound to the session |
| ClientExtendParamsJson | string | no | The authentication context generated by the client SDK |
| ClientExtendParamsJsonSign | string | no | The signature information of the authentication context generated by the client SDK |
| ServerExtendParamsJson | string | no | The server-side configuration item that determines the authentication requirement attributes |
| UserSourceIp | string | no | The source IP address of the user, used for auditing |
| LogParams | string | no | The custom audit log information recorded by the user |

### Determines the authentication method based on ServiceCode and Action
`POST https://zieapi.vercel.app/v1/cloud:aliyun-idaas-doraemon/service-invoke` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://idaas-doraemon.aliyuncs.com |
| MobileExtendParamsJson | string | no | The parameters generated by the mobile SDK |
| MobileExtendParamsJsonSign | string | no | The parameters generated by the mobile SDK |
| ServerExtendParamsJson | string | no | The server-side configuration parameters |
| ServiceCode | string | yes | The authentication method |
| DoraemonAction | string | yes | The operation type |
| ApplicationExternalId | string | yes | The external ID of the application |
| TestModel | string | no | Specifies whether to enable test mode. This parameter does not take effect in the production environment |
| XClientIp | string | no | The client IP address |

### Updates the name of an authenticator
`POST https://zieapi.vercel.app/v1/cloud:aliyun-idaas-doraemon/update-authenticator-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://idaas-doraemon.aliyuncs.com |
| ApplicationExternalId | string | yes | The external ID of the application |
| UserId | string | yes | The user ID |
| AuthenticatorName | string | yes | The name of the authenticator |
| AuthenticatorUuid | string | yes | The UUID of the authenticator |

### Verifies an IdToken. After phone number verification or IFAA authentication succeeds, the obtained IdToken…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-idaas-doraemon/verify-id-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://idaas-doraemon.aliyuncs.com |
| JwtIdToken | string | no | jwtIdToken |
| ApplicationExternalId | string | no | The external ID of the application |

### Verifies an authenticator
`POST https://zieapi.vercel.app/v1/cloud:aliyun-idaas-doraemon/verify-user-authentication` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://idaas-doraemon.aliyuncs.com |
| ApplicationExternalId | string | yes | The external ID of the application |
| AuthenticatorType | string | yes | The type of the authenticator |
| UserId | string | yes | The ID of the user |
| AuthenticationContext | string | yes | The authentication context. The format is determined by the AuthenticatorType |
| RequireChallengeBase64 | string | no | The Base64-encoded challenge identifier bound to the session |
| RequireBindHashBase64 | string | no | The Base64-encoded operation hash identifier bound to the authentication |
| ClientExtendParamsJson | string | no | The authentication context generated by the client SDK |
| ClientExtendParamsJsonSign | string | no | The signature information of the authentication context generated by the client SDK |
| ServerExtendParamsJson | string | no | The server-side configuration item that determines the authentication requirement properties |
| UserSourceIp | string | no | The source IP address of the user, used for auditing |
| LogTag | string | no | The custom tag for audit log records |
| LogParams | string | no | The custom information for audit log records |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-idaas-doraemon/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://idaas-doraemon.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-idaas-doraemon/create-authenticator-registration" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Idaas Auth API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-idaas-doraemon/create-authenticator-registration with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Idaas Auth API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Idaas Auth itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Idaas Auth API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-idaas-doraemon.

### What is the status of the Alibaba Cloud Idaas Auth API?
Needs your own provider key (bring your own key)