API 標準および多言語対応の SDK
本製品 (cloudsso/2021-05-15) の API は、RPC 標準に準拠した 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 ペア
CloudSSO の管理
|
API |
タイトル |
説明 |
| EnableService | EnableService | CloudSSO を有効にします。 |
| DisableService | DisableService | CloudSSO を無効化します。 |
| GetServiceStatus | GetServiceStatus | CloudSSO のステータスを照会します。 |
| ListDirectories | ListDirectories | ディレクトリを照会します。 |
| GetDirectory | GetDirectory | ディレクトリの情報を照会します。 |
| GetDirectoryStatistics | GetDirectoryStatistics | ディレクトリの統計情報をクエリします。 |
| UpdateDirectory | UpdateDirectory | ディレクトリの名前を変更します。 |
| EnableDelegateAccount | EnableDelegateAccount | CloudSSO のデリゲート管理者アカウントを有効にします。 |
| DisableDelegateAccount | DisableDelegateAccount | CloudSSO のデリゲート管理者アカウントを無効にします。 |
ユーザーの管理
|
API |
タイトル |
説明 |
| UpdateUserStatus | UpdateUserStatus | ユーザーのステータスを変更します。 |
| ListMFADevicesForUser | ListMFADevicesForUser | ユーザーにバインドされている多要素認証 (MFA) デバイスを照会します。1 人のユーザーに最大 2 つの MFA デバイスをバインドできます。 |
| DeleteMFADeviceForUser | DeleteMFADeviceForUser | ユーザーから多要素認証 (MFA) デバイスのバインドを解除します。 |
| UpdateMFAAuthenticationSettings | UpdateMFAAuthenticationSettings | すべてのユーザーの多要素認証 (MFA) 設定を変更します。 |
| GetMFAAuthenticationSettings | GetMFAAuthenticationSettings | すべてのユーザーの多要素認証 (MFA) 設定をクエリします。 |
| UpdateUserMFAAuthenticationSettings | UpdateUserMFAAuthenticationSettings | 単一ユーザーの多要素認証 (MFA) 設定を変更します。 |
| GetUserMFAAuthenticationSettings | GetUserMFAAuthenticationSettings | 単一ユーザーの多要素認証 (MFA) 設定を照会します。 |
| GetMFAAuthenticationSettingInfo | GetMFAAuthenticationSettingInfo | すべてのユーザーの多要素認証 (MFA) 設定をクエリします。 |
| SetLoginPreference | SetLoginPreference | CloudSSO ユーザーのログインプリファレンスを設定します。 |
| GetLoginPreference | GetLoginPreference | CloudSSO ユーザーのログインプリファレンスを照会します。 |
| SetPasswordPolicy | SetPasswordPolicy | CloudSSO ユーザーのパスワードポリシーを設定します。 |
| GetPasswordPolicy | GetPasswordPolicy | CloudSSO ユーザーのパスワードポリシーを照会します。 |
| GetUserId | GetUserId | \`ExternalId` パラメーターを使用して、リソースディレクトリ内のユーザーの ID を照会します。 |
ユーザーグループの管理
|
API |
タイトル |
説明 |
| AddUserToGroup | AddUserToGroup | ユーザーをグループに追加します。 |
| RemoveUserFromGroup | RemoveUserFromGroup | ユーザーをグループから削除します。 |
| ListJoinedGroupsForUser | ListJoinedGroupsForUser | ユーザーが追加されているグループを照会します。 |
| ListGroupMembers | ListGroupMembers | グループ内のユーザーを照会します。 |
SCIM 同期の管理
|
API |
タイトル |
説明 |
| CreateSCIMServerCredential | CreateSCIMServerCredential | クロスドメイン ID 管理システム (SCIM) の認証情報を作成します。 |
| ListSCIMServerCredentials | ListSCIMServerCredentials | SCIM (Cross-domain Identity Management) の認証情報を照会します。 |
| UpdateSCIMServerCredentialStatus | UpdateSCIMServerCredentialStatus | System for Cross-domain Identity Management (SCIM) 認証情報の有効／無効を切り替えます。 |
| DeleteSCIMServerCredential | DeleteSCIMServerCredential | Cross-domain Identity Management (SCIM) 認証情報を削除します。 |
| SetSCIMSynchronizationStatus | SetSCIMSynchronizationStatus | System for Cross-domain Identity Management (SCIM) 同期を有効化または無効化します。 |
| GetSCIMSynchronizationStatus | GetSCIMSynchronizationStatus | クロスドメイン ID 管理システム (SCIM) 同期のステータスをクエリします。 |
シングルサインオンの管理
|
API |
タイトル |
説明 |
| GetDirectorySAMLServiceProviderInfo | GetDirectorySAMLServiceProviderInfo | Security Assertion Markup Language (SAML) のサービスプロバイダー (SP) に関する情報をクエリします。 |
| SetExternalSAMLIdentityProvider | SetExternalSAMLIdentityProvider | Security Assertion Markup Language (SAML) ID プロバイダー (IdP) を構成します。 |
| GetExternalSAMLIdentityProvider | GetExternalSAMLIdentityProvider | Security Assertion Markup Language (SAML) ID プロバイダー (IdP) の構成をクエリします。 |
| ClearExternalSAMLIdentityProvider | ClearExternalSAMLIdentityProvider | Security Assertion Markup Language (SAML) ID プロバイダー (IdP) の構成をクリアします。 |
| AddExternalSAMLIdPCertificate | AddExternalSAMLIdPCertificate | Security Assertion Markup Language (SAML) 署名証明書を追加します。 |
| ListExternalSAMLIdPCertificates | ListExternalSAMLIdPCertificates | Security Assertion Markup Language (SAML) 署名証明書をクエリします。 |
| RemoveExternalSAMLIdPCertificate | RemoveExternalSAMLIdPCertificate | Security Assertion Markup Language (SAML) 署名証明書を削除します。 |
アクセス構成の管理
|
API |
タイトル |
説明 |
| CreateAccessConfiguration | CreateAccessConfiguration | アクセス構成を作成します。 |
| ListAccessConfigurations | ListAccessConfigurations | アクセス構成のリストを照会します。 |
| GetAccessConfiguration | GetAccessConfiguration | GetAccessConfiguration 操作を呼び出して、アクセス構成の詳細をクエリします。 |
| UpdateAccessConfiguration | UpdateAccessConfiguration | アクセス構成の情報を変更します。 |
| DeleteAccessConfiguration | DeleteAccessConfiguration | アクセス構成を削除します。 |
| AddPermissionPolicyToAccessConfiguration | AddPermissionPolicyToAccessConfiguration | アクセス構成にポリシーを追加します。 |
| RemovePermissionPolicyFromAccessConfiguration | RemovePermissionPolicyFromAccessConfiguration | アクセス構成からポリシーを削除します。 |
| UpdateInlinePolicyForAccessConfiguration | UpdateInlinePolicyForAccessConfiguration | アクセス構成に作成されたインラインポリシーを変更します。 |
| ListPermissionPoliciesInAccessConfiguration | ListPermissionPoliciesInAccessConfiguration | アクセス構成に作成されたポリシーをクエリします。 |
マルチアカウント権限付与の管理
|
API |
タイトル |
説明 |
| ProvisionAccessConfiguration | ProvisionAccessConfiguration | リソースディレクトリ内のアカウントに対してアクセス構成をプロビジョニングします。 |
| DeprovisionAccessConfiguration | DeprovisionAccessConfiguration | リソースディレクトリ内のアカウントからアクセス構成のプロビジョニングを解除します。 |
| ListAccessConfigurationProvisionings | ListAccessConfigurationProvisionings | プロビジョニング済みのアクセス構成をクエリします。 |
| CreateAccessAssignment | CreateAccessAssignment | アクセス構成を使用して、リソースディレクトリ内のアカウントに対するアクセス権限をユーザーまたはグループに割り当てます。 |
| ListAccessAssignments | ListAccessAssignments | 割り当てられているアクセス権限をクエリします。 |
| DeleteAccessAssignment | DeleteAccessAssignment | リソースディレクトリのアカウントに対するアクセス権限を削除します。 |
RAM ユーザー同期の管理
|
API |
タイトル |
説明 |
| CreateUserProvisioning | CreateUserProvisioning | Resource Access Management (RAM) ユーザープロビジョニングを作成します。 |
| GetUserProvisioning | GetUserProvisioning | Resource Access Management (RAM) のユーザープロビジョニングを照会します。 |
| ListUserProvisionings | ListUserProvisionings | Resource Access Management (RAM) のユーザープロビジョニングをクエリします。 |
| UpdateUserProvisioning | UpdateUserProvisioning | Resource Access Management (RAM) ユーザープロビジョニングを変更します。 |
| DeleteUserProvisioning | DeleteUserProvisioning | Resource Access Management (RAM) ユーザーのプロビジョニングを削除します。 |
| UpdateUserProvisioningConfiguration | UpdateUserProvisioningConfiguration | Resource Access Management (RAM) ユーザープロビジョニングのグローバル構成を変更します。 |
| GetUserProvisioningConfiguration | GetUserProvisioningConfiguration | Resource Access Management (RAM) ユーザープロビジョニングのグローバル構成を照会します。 |
| ListUserProvisioningEvents | ListUserProvisioningEvents | Resource Access Management (RAM) ユーザープロビジョニングイベントをクエリします。 |
| GetUserProvisioningEvent | GetUserProvisioningEvent | Resource Access Management (RAM) ユーザープロビジョニングに関する情報をクエリします。 |
| DeleteUserProvisioningEvent | DeleteUserProvisioningEvent | Resource Access Management (RAM) ユーザープロビジョニングイベントを削除します。 |
| RetryUserProvisioningEvent | RetryUserProvisioningEvent | Resource Access Management (RAM) ユーザープロビジョニングイベントを再試行します。 |
| GetUserProvisioningStatistics | GetUserProvisioningStatistics | Resource Access Management (RAM) ユーザープロビジョニングの統計を照会します。 |
| GetUserProvisioningRdAccountStatistics | GetUserProvisioningRdAccountStatistics | リソースディレクトリ内のメンバーに対して作成された Resource Access Management (RAM) ユーザーのプロビジョニングイベントに関する統計を照会します。 |
その他（非推奨）
|
API |
タイトル |
説明 |
| SetMFAAuthenticationStatus | SetMFAAuthenticationStatus | ディレクトリ内のユーザーに対して多要素認証 (MFA) を有効または無効にします。 |
| GetMFAAuthenticationStatus | GetMFAAuthenticationStatus | ユーザーに対して多要素認証 (MFA) が有効になっているかどうかを確認します。 |
Others
|
API |
タイトル |
説明 |
| CreateDirectory | CreateDirectory | ディレクトリを作成します。 |
| CreateGroup | CreateGroup | グループを作成します。 |
| CreateUser | CreateUser | ユーザーを作成します。 |
| DeleteDirectory | DeleteDirectory | ディレクトリを削除します。 |
| DeleteGroup | DeleteGroup | グループを削除します。 |
| DeleteUser | DeleteUser | ユーザーを削除します。 |
| GetGroup | GetGroup | グループに関する情報を照会します。 |
| GetTask | GetTask | 非同期タスクの情報をクエリします。 |
| GetTaskStatus | GetTaskStatus | 非同期タスクのステータスを照会します。 |
| GetUser | GetUser | 指定されたユーザーの情報を取得します。 |
| ListGroups | ListGroups | グループをクエリします。 |
| ListTasks | ListTasks | 非同期タスクをクエリします。 |
| ListUsers | ListUsers | ユーザーのリストを照会します。 |
| ResetUserPassword | ResetUserPassword | ユーザーのパスワードをリセットします。 |
| UpdateGroup | UpdateGroup | グループの情報を変更します。 |
| UpdateUser | UpdateUser | ユーザーに関する情報を変更します。 |