Application development API

更新时间:
复制 MD 格式

1. Overview

This document describes the Identity as a Service (IDaaS) APIs for managing accounts and organizational units. Use these APIs to integrate IDaaS data into your applications.

The APIs fall into four categories:

  1. Get an access token. An access token is required to call all other APIs.

  2. Query and manage accounts

  3. Query and manage organizational units

  4. Get the synchronization scope. You must manage accounts and organizational units within the specified synchronization scope.

2. Making API calls

Authentication

Before calling most IDaaS APIs, you must get an access token.

See General configurations for instructions on how to get the client_id and client_secret from the General tab of your application, and then get a token.

Note

Note: Unlike Alibaba Cloud OpenAPI, the Developer APIs for an IDaaS application use the application's secret. You manage permissions for these APIs within IDaaS, not through Resource Access Management (RAM).

SDKs, sample code, and debugging

We recommend that you use an SDK to call the APIs.

The Alibaba Cloud OpenAPI Explorer provides the following features to help you work with IDaaS SDKs:

On the API Debugging page, click Download Project to get a complete project that includes SDK installation instructions and call examples.

Direct API calls

Alternatively, you can call the APIs directly by using your own development or testing tools.

For a list of APIs, see the Alibaba Cloud IDaaS API list.

API list

The following table lists some example APIs. For detailed API information, see the detailed API reference.

Category

Use case

APIs

Permission value

Token

Get a token

  • Get a token: GenerateToken

-

Account

Account management APIs

  • Create an account: CreateUser

  • Update an account: PatchUser

  • Delete an account: DeleteUser

  • Enable an account: EnableUser

  • Disable an account: DisableUser

urn:alibaba:idaas:scope:user:manager_all

Account query APIs

  • Get account information: GetUser

  • List accounts: ListUsers

  • Get account password policy: GetUserPasswordPolicy

urn:alibaba:idaas:scope:user:read_all

Organizational unit

Organizational unit management APIs

  • Create an organizational unit: CreateOrganizationalUnit

  • Partially update an organizational unit: PatchOrganizationalUnit

  • Delete an organizational unit: DeleteOrganizationalUnit

urn:alibaba:idaas:scope:organizational_unit:manager_all

Organizational unit query APIs

  • Get organizational unit information: GetOrganizationalUnit

  • List organizational units: ListOrganizationalUnits

  • List parent IDs of an organizational unit: ListOrganizationalUnitParentIds

urn:alibaba:idaas:scope:organizational_unit:read_all

Synchronization scope

Get the synchronization scope

  • Get the synchronization scope: GetApplicationProvisioningScope

-