Skip to main content
Invitation Management

Create Member Invite Link

Create a TokenPlan member invitation link.

Prerequisites

You have obtained the AccessKey of an Alibaba Cloud account or a RAM user, and the identity has been granted the RAM permissions required to call this operation. We recommend that you set the AccessKey as the environment variables ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET instead of hard-coding it.

Request description

  • HTTP method:POST
  • Request URL

    Region

    Endpoint

    Singapore

    POST https://modelstudio.ap-southeast-1.aliyuncs.com/tokenplan/invite/link/create

  • Authentication This operation is an Alibaba Cloud OpenAPI operation that uses AccessKey-based signatures (the ACS3-HMAC-SHA256 algorithm). The Authorization: Bearer {API_KEY} scheme is not supported. A request must carry the common headers x-acs-action: CreateTokenPlanInviteLink, x-acs-version: 2026-02-10, x-acs-date, x-acs-content-sha256, x-acs-signature-nonce, and Authorization. We recommend that you call this operation with an Alibaba Cloud SDK or OpenAPI Explorer so that you do not have to calculate the signature yourself.
Each user is allowed to have only one valid invitation link.
If the user already has a valid invitation link, this API will return that link.
To create a new link, call the RevokeTokenPlanInviteLink API to invalidate the current link.
该接口只返回生成的 token,邀请链接的拼接格式为 https://{host}/accept-invite?token=[token]&orgId=[orgId]
For the China site, the host is tokenplan-enterprise.bailian.aliyunportal.com.
For the international site, the host is tokenplan-enterprise.modelstudio.aliyunportal.com.

Request parameters

All parameters are passed in the query string.

Parameter

Type

Required

Description

ExpireType

string

No

Expiration tier. Default: DAYS_7.
DAYS_7
DAYS_30
MONTHS_6
YEAR_1

SsoSource

string

Yes

SSO login method bound to the invitation link:
SAML
DINGTALK

Response parameters

Parameter

Type

Description

Success

boolean

Whether the API call was successful:
true: success
false: failure

Code

string

Response status code.

Message

string

Response message.

Data

object

Business parameters.

Token

string

Generated token.

Request example

This operation uses Alibaba Cloud OpenAPI signatures. In the following example, ${SIGNATURE} must be calculated with the ACS3-HMAC-SHA256 algorithm, and x-acs-date and x-acs-signature-nonce must be replaced with actual values.
curl -X POST "https://modelstudio.ap-southeast-1.aliyuncs.com/tokenplan/invite/link/create?ExpireType=DAYS_7&SsoSource=SAML" \
    --header "x-acs-action: CreateTokenPlanInviteLink" \
    --header "x-acs-version: 2026-02-10" \
    --header "x-acs-date: 2026-01-01T12:00:00Z" \
    --header "x-acs-content-sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" \
    --header "x-acs-signature-nonce: 3e3b2a9f0c7d4f8e9a1b2c3d4e5f6a7b" \
    --header "Authorization: ACS3-HMAC-SHA256 Credential=${ALIBABA_CLOUD_ACCESS_KEY_ID},SignedHeaders=host;x-acs-action;x-acs-content-sha256;x-acs-date;x-acs-signature-nonce;x-acs-version,Signature=${SIGNATURE}"

Response example

{
  "Success": true,
  "Data": {
    "Token": "sk-ws-D.****.*******"
  }
}

Error codes

If the call fails, an error message is returned. For more error codes and solutions, see Error codes.
Text Generation
Image Generation
  • FAQ
Video Generation
World models
Audio
  • Audio generation
Realtime API
Text Embedding
TokenPlan
Model Production