資格情報エンドポイント
資格情報エンドポイントとパラメーター
オブジェクト関係に関する詳細とAPIでの使用方法については、 オブジェクト関係 のセクションを参照してください。
資格情報の詳細については、 資格情報 のヘルプページを参照してください。
注記
APIを使用して資格情報を作成することは許可されていません。管理者として資格情報を作成するには Server UI を使用します。
すべての資格情報レコードを取得する
アクセス可能なすべての資格情報レコードを取得するには、
GET {baseURL}/v3/credentials
エンドポイントを使用します。
注記
管理者ではない場合、結果はアクセス権を持つ資格情報に制限され、view、userId、userGroupIdパラメーターは無視されます。
パラメーター
view (文字列): オプションです。値を指定しないこともできます。値は「Default」(既定)と「Full」(完全)から選択できます。このパラメーターを「Default」(既定)に設定すると、縮小表示オブジェクトが返されます。指定しない場合は、「Default」(既定)の値が使用されます。
userId (文字列): オプションです。userIdで結果をフィルタリングするには、ユーザーのIDを入力します。
userGroupId (文字列): オプションです。userGroupIdで結果をフィルタリングするには、ユーザーグループのIDを入力します。
資格情報レコードを取得する
既存の資格情報の詳細を取得するには、
GET {baseURL}/v3/credentials/{credentialId}
エンドポイントを使用します。
パラメーター
credentialId (文字列): 必須です。コレクションIDを入力して、特定の資格情報に関する情報を取得します。
資格情報をユーザーと共有する
既存の資格情報を既存のユーザーと共有するには、
POST {baseURL}
/v3/credentials/{credentialId}/users
エンドポイントを使用します。
注記
このAPIエンドポイントを使用できるのは管理者のみです。
パラメーター
credentialId (文字列): 必須です。共有するコレクションIDを入力します。
contract (本文): 必須です。資格情報をユーザーと共有するには、次のように指定します。
userId (文字列): 必須です。資格情報を共有するユーザーのIDを指定します。
資格情報をユーザーグループと共有する
既存の資格情報を既存のユーザーグループと共有するには、
POST {baseURL}
/v3/credentials/{credentialId}/userGroups
エンドポイントを使用します。
注記
このAPIエンドポイントを使用できるのは管理者のみです。
パラメーター
credentialId (文字列): 必須です。共有する資格情報IDを入力します。
contract (本文): 必須です。資格情報をユーザーグループと共有するには、次のように指定します。
userGroupId (文字列): 必須です。資格情報を共有するユーザーグループのIDを指定します。
資格情報を使用するユーザーの権限を削除する
既存の資格情報を使用するユーザーの権限を削除するには、
DELETE {baseURL}/v3/credentials/{credentialId}/users/{userId}
エンドポイントを使用します。
注記
このAPIエンドポイントを使用できるのは管理者のみです。
パラメーター
credentialId (文字列): 必須です。ユーザーを削除する資格情報IDを入力します。
userId (文字列): 必須です。資格情報から削除するユーザーIDを入力します。
資格情報を使用するユーザーグループの権限を削除する
既存の資格情報を使用するユーザーグループの権限を削除するには、
DELETE {baseURL}/v3/credentials/{credentialId}/userGroups/{userGroupId}
エンドポイントを使用します。
注記
このAPIエンドポイントを使用できるのは管理者のみです。
パラメーター
credentialId (文字列): 必須です。ユーザーグループを削除する資格情報IDを入力します。
userGroupId (文字列): 必須です。資格情報から削除するユーザーグループIDを入力します。
資格情報を削除する
既存の資格情報を削除するには、
DELETE {baseURL}/v3/credentials/{credentialId}
エンドポイントを使用します。
注記
このAPIエンドポイントを使用できるのは管理者のみです。
パラメーター
credentialId (文字列): 必須です。削除する資格情報IDを入力します。
force (ブール型): オプションです。共有がある場合に資格情報を強制的に削除するかどうかを選択します。資格情報を削除し、すべての共有をクリーンアップする場合は、forceパラメーターをtrueに設定します。選択しない場合、既定値はfalseです。この設定は誤った呼び出しを防止するために使用されます。
オブジェクト関係
既存の資格情報IDに関する情報を取得するには、 GET /v3/credentials エンドポイントを使用します。取得した credentialId は、次の場合に使用できます。
資格情報をユーザーと共有する 場合。
ユーザーを資格情報から削除する 場合。
特定の資格情報を削除する 場合。