API の概要 - Identity as a Service - Alibaba Cloud ドキュメントセンター

API 標準および多言語対応の SDK

本製品 (Eiam-developerapi/2022-02-25) の API は、ROA 標準に準拠した OpenAPI 仕様を採用しています。Alibaba Cloud には主要なプログラミング言語に対応した SDK が用意され、リクエスト署名のような手間がかかる手順を省略できます。そのため、開発者は HTTP 通信の詳細を意識することなく、各言語の構文で API を呼び出すことが可能になります。

カスタム署名

署名のカスタマイズが必要な場合、「署名メカニズム」を参照してリクエストに手動で署名できます。手動署名プロセスは非常に煩雑で、通常はおよそ 5 営業日かかります。詳細については、DingTalk サポート窓口 (グループチャット ID：147535001692) までお問い合わせください。

はじめに

Alibaba Cloud アカウント (root ユーザー) は最高レベルの管理権限を持ち、その AccessKey ペアが悪用されると、関連するすべてのリソースが不正にアクセスされ、重大なセキュリティリスクを引き起こす可能性があります。そのため、必要な場合以外は、Alibaba Cloud アカウントを使用しないでください。その代わりに、API のみでのアクセスを許可された Resource Access Management (RAM) ユーザーを作成し、RAM ポリシーを設定することで、最小権限の原則 (PoLP) を徹底してください。

API セキュリティを確保するには、以下を作成し、設定する必要があります。

RAM ユーザー
RAM ユーザー用の AccessKey ペア

認証トークン API

API	タイトル	説明
ObtainJwtAuthenticationToken	ObtainJwtAuthenticationToken	JWT 認証トークンを取得します。
FetchOAuthAuthenticationToken	FetchOAuthAuthenticationToken	有効な OAuth 認証トークンをフェッチします。
GenerateJwtAuthenticationToken	GenerateJwtAuthenticationToken	JSON Web トークン (JWT) 認証トークンを生成します。
ListAuthenticationTokens	ListAuthenticationTokens	認証トークンを一覧表示します。
ObtainJwtAuthenticationTokenByDerivedShortToken	ObtainJwtAuthenticationTokenByDerivedShortToken	派生ショートトークンを使用して JWT 認証トークンを取得します。
ReinstateAuthenticationToken	ReinstateAuthenticationToken	認証トークンを復元します。
ReinstateAuthenticationTokenByConsumer	ReinstateAuthenticationTokenByConsumer	コンシューマー向けの認証トークンを復元します。
RevokeAuthenticationToken	RevokeAuthenticationToken	認証トークンを取り消します。
RevokeAuthenticationTokenByConsumer	RevokeAuthenticationTokenByConsumer	コンシューマーの認証トークンを取り消します。
ValidateAuthenticationToken	ValidateAuthenticationToken	認証トークンを検証します。

認証情報 API

API	タイトル	説明
CreateUserExclusiveCredential	CreateUserExclusiveCredential	ユーザー専用認証情報を作成します。
ObtainCredential	ObtainCredential	シークレットのプレーンテキストを取得します。

クラウドロールアクセス認証情報 API

API	タイトル	説明
ObtainCloudAccountRoleAccessCredential	ObtainCloudAccountRoleAccessCredential	CloudAccountRole の一時的なアクセス認証情報を取得します。

OIDC API

API	タイトル	説明
GenerateTokenByAuthorizationServer	GenerateTokenByAuthorizationServer	インスタンスレベルの認可サーバーのトークンエンドポイント。
GenerateToken	GenerateToken	指定された IDaaS インスタンス内のアプリケーションに対して、認証情報に基づいてアクセストークンを生成します。
GenerateDeviceCode	GenerateDeviceCode	デバイスコードを生成します。
GetUserInfo	GetUserInfo	ユーザートークンを使用して、ユーザー情報を取得します。
RevokeToken	RevokeToken	アクセストークンまたはトークンの更新を無効化します。

権限付与範囲 API

API	タイトル	説明
GetApplicationProvisioningScope	GetApplicationProvisioningScope	GetApplicationProvisioningScope 操作は、特定のインスタンスにおけるアプリケーションの同期範囲を取得します。

組織管理 API

API	タイトル	説明
CreateOrganizationalUnit	CreateOrganizationalUnit	組織単位を作成します。
PatchOrganizationalUnit	PatchOrganizationalUnit	EIAM の組織単位を変更します。
GetOrganizationalUnit	GetOrganizationalUnit	組織単位の情報を取得します。
DeleteOrganizationalUnit	DeleteOrganizationalUnit	組織単位を削除します。
ListOrganizationalUnits	ListOrganizationalUnits	EIAM から組織情報を取得するためのページングクエリを実行します。
ListOrganizationalUnitParentIds	ListOrganizationalUnitParentIds	組織単位のすべての親組織単位に関する情報を取得します。
GetOrganizationalUnitIdByExternalId	GetOrganizationalUnitIdByExternalId	外部 ID に基づいて組織単位の ID を取得します

アカウント管理 API

API	タイトル	説明
CreateUser	CreateUser	指定された組織に新しい EIAM アカウントを作成します。
PatchUser	PatchUser	Employee Identity and Access Management (EIAM) アカウントを変更します。
GetUser	GetUser	Employee Identity and Access Management (EIAM) アカウントの詳細情報を取得します。
UpdateUserPassword	UpdateUserPassword	指定された EIAM アカウントのパスワードを更新します。
DeleteUser	DeleteUser	Employee Identity and Access Management (EIAM) アカウントを削除します。
ListUsers	ListUsers	EIAM アカウント情報をページングクエリで取得します。
EnableUser	EnableUser	Employee Identity and Access Management (EIAM) アカウントを有効化します。
DisableUser	DisableUser	Employee Identity and Access Management (EIAM) のアカウントを無効化します。
GetUserIdByEmail	GetUserIdByEmail	メールアドレスを指定して、Employee Identity and Access Management (EIAM) アカウントの ID を照会します。
GetUserIdByPhoneNumber	GetUserIdByPhoneNumber	モバイル番号に基づき、Employee Identity and Access Management (EIAM) アカウントの ID を照会します。
GetUserIdByUserExternalId	GetUserIdByUserExternalId	外部 ID に基づいて、Employee Identity and Access Management (EIAM) アカウントの ID を照会します。
GetUserIdByUsername	GetUserIdByUsername	ユーザー名に基づいて、Employee Identity and Access Management (EIAM) アカウントの ID を照会します。
SetUserPrimaryOrganizationalUnit	SetUserPrimaryOrganizationalUnit	EIAM アカウントの主組織を設定します。この操作により、アカウントは旧主組織から削除され、新しい主組織に追加されます。
AddUserToOrganizationalUnits	AddUserToOrganizationalUnits	EIAM アカウントを 1 つ以上の EIAM 組織に追加します。これらの組織は、当該アカウントの下位組織として機能します。指定された組織に既にアカウントが所属している場合、更新処理は実行されません。
RemoveUserFromOrganizationalUnits	RemoveUserFromOrganizationalUnits	1 つ以上の EIAM 組織単位から EIAM アカウントを削除します。指定された組織単位にアカウントが存在しない場合でも、この操作は成功します。
ListGroupsForUser	ListGroupsForUser	EIAM ユーザーが所属するグループの一覧を取得します。

アカウントグループ管理 API

API	タイトル	説明
GetGroup	GetGroup	グループの詳細を照会します。
CreateGroup	CreateGroup	グループを作成します。
PatchGroup	PatchGroup	Employee Identity and Access Management (EIAM) グループの情報を変更します。
DeleteGroup	DeleteGroup	グループを削除します。
ListGroups	ListGroups	Employee Identity and Access Management (EIAM) のグループ情報をページ単位で取得します。
AddUsersToGroup	AddUsersToGroup	複数の Employee Identity and Access Management (EIAM) アカウントを EIAM グループに追加します。アカウントが指定されたグループにすでに追加されている場合、更新は実行されません。
RemoveUsersFromGroup	RemoveUsersFromGroup	複数の Employee Identity and Access Management (EIAM) アカウントを EIAM グループから削除します。アカウントがグループに属していない場合、デフォルトで削除は成功します。
ListUsersForGroup	ListUsersForGroup	Employee Identity and Access Management (EIAM) グループ内のアカウントを照会します。