CloudSSO supports multiple integration methods: OpenAPI online debugging, Alibaba Cloud SDK, Alibaba Cloud CLI. Choose the method that best suits your needs.
OpenAPI introduction
The Alibaba Cloud OpenAPI portal provides intelligent search, documentation, online debugging, SDK retrieval, code samples, error diagnosis, and API call statistics. You can call APIs, view requests and responses, and generate SDK call samples. What is OpenAPI?.
Version guide
Alibaba Cloud OpenAPI uses version numbers to manage cloud product APIs. CloudSSO supports the 2021-05-15 API version. This identifies the API version, not a date. The displayed APIs are the latest public versions and are continuously updated.
|
Version number |
Description |
|
Recommended |
Online debugging
CloudSSO supports API debugging in the OpenAPI portal. Before calling an API, understand the available versions, endpoints, and integration methods.
Debugging portal
To debug APIs, go to the CloudSSO API debugging list.
Endpoints
Choose the endpoint for the region where your resources are located. For example, in the China (Shanghai) region, the public endpoint is cloudsso.cn-shanghai.aliyuncs.com and the VPC endpoint is cloudsso-vpc.cn-shanghai.aliyuncs.com.
-
Public endpoints are accessible globally.
-
VPC endpoints are accessible only from a VPC in the corresponding Alibaba Cloud region. VPC endpoints offer the following advantages:
-
High security: Accessible only from within a VPC.
-
Faster response: Internal network avoids public network latency and bandwidth limits.
-
Lower cost: Uses internal network communication.
-
For the full list of supported regions, see Endpoints.
User identities
By default, the OpenAPI portal uses your Alibaba Cloud account credentials for debugging. Because an Alibaba Cloud account has full API access, we recommend using a RAM user instead. Grant the RAM user the required CloudSSO permissions before calling APIs. Use RAM for access control.
|
User identity |
Support |
|
Support |
|
|
RAM user (Recommended) |
Support |
|
RAM role (Recommended) |
Support |
More information
Integration methods
We recommend using an SDK to call OpenAPI. SDKs provide the easiest integration and best support.
Integration methods overview
|
Method |
Support |
|
Alibaba Cloud SDK (Recommended) |
Supported |
|
Supported |
|
|
No |
|
|
Support |
-
Alibaba Cloud SDK
-
Alibaba Cloud provides SDKs for Java, C#, Go, Python, Node.js/TypeScript, PHP, and C++. SDKs encapsulate signing, timeout, and retry logic and return structured response objects. Alibaba Cloud SDKs.
-
For supported languages and installation instructions, see CloudSSO SDK.
-
-
Alibaba Cloud CLI
-
Alibaba Cloud CLI provides the
aliyuncommand to interact with Alibaba Cloud services from a terminal. What is Alibaba Cloud CLI?. -
You can use Alibaba Cloud CLI to call CloudSSO.
-
-
Resource Orchestration Service (ROS)
-
ROS lets you define Alibaba Cloud resources and their dependencies in templates. The orchestration engine automatically creates and configures resources for automated deployment. What is Resource Orchestration Service?.
-
You cannot use ROS to manage CloudSSO resources.
-
-
Custom API call encapsulation
For native HTTP calls, implement the signature algorithm and construct the request as described in CloudSSO API overview and V3 request body & signing mechanism.
Notes
If a CloudSSO API call returns an error, check the error code to verify that request parameters and values are correct.
You can also use the RequestID from the response or SDK error message to run self-service diagnostics on the Alibaba Cloud OpenAPI Diagnostic Platform.
References
-
CloudSSO provides unified identity management and access control based on an Alibaba Cloud resource directory (RD). It enables centralized user management, SSO from your corporate identity provider, and unified access control across RD accounts. What is CloudSSO?.
-
Supported SDK languages are listed in SDK overview.