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