CloudSSO:UpdateSCIMServerCredentialStatus - CloudSSO

操作説明

このトピックでは、ID が scimcred-004whl0kvfwcypbi**** の SCIM 認証情報を無効化する方法について例示します。SCIM 認証情報が無効化されると、当該認証情報を使用する同期タスクは失敗します。再度この操作を呼び出して、SCIM 認証情報を有効化できます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cloudsso:UpdateSCIMServerCredentialStatus

update

*SCIMServerCredential

acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/scim-credential/{#CredentialId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DirectoryId	string	必須	ディレクトリの ID です。	d-00fc2p61****
CredentialId	string	必須	SCIM 認証情報の ID です。	scimcred-004whl0kvfwcypbi****
NewStatus	string	任意	SCIM 認証情報の新しいステータスです。有効な値は以下のとおりです。 Enabled：SCIM 認証情報が有効です。 Disabled：SCIM 認証情報が無効です。	Disabled

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーターです。
RequestId	string	リクエスト ID です。	7C086C2F-1C66-57B3-B14E-2C1DA70727CD
SCIMServerCredential	object	SCIM 認証情報に関する情報です。
Status	string	SCIM 認証情報のステータスです。有効な値は以下のとおりです。 Enabled：SCIM 認証情報が有効です。 Disabled：SCIM 認証情報が無効です。	Disabled
DirectoryId	string	ディレクトリの ID です。	d-00fc2p61****
CredentialId	string	SCIM 認証情報の ID です。	scimcred-004whl0kvfwcypbi****
CreateTime	string	SCIM 認証情報が作成された時刻です。	2021-11-09T08:12:52Z
CredentialType	string	SCIM 認証情報のタイプです。	BearerToken
ExpireTime	string	SCIM 認証情報の有効期限です。	2022-11-09T08:12:52Z

例

成功レスポンス

JSONJSON

{
  "RequestId": "7C086C2F-1C66-57B3-B14E-2C1DA70727CD",
  "SCIMServerCredential": {
    "Status": "Disabled",
    "DirectoryId": "d-00fc2p61****",
    "CredentialId": "scimcred-004whl0kvfwcypbi****",
    "CreateTime": "2021-11-09T08:12:52Z",
    "CredentialType": "BearerToken",
    "ExpireTime": "2022-11-09T08:12:52Z"
  }
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。