組織レベルの効果的なアクセス権を取得する

Test Cloud で複数のアクティブなテナントにわたってプリンシパルのロールと割り当てを取得するための、組織レベルの有効なアクセス API です。

組織全体のユーザー、グループ、または外部アプリケーションに対する有効なアクセス権を取得します。この応答では、組織範囲の割り当てが、すべてのアクティブなテナントからのテナント レベルの割り当てと結合されます。フォルダー レベルの割り当ての詳細は含まれません。

API エンドポイント

POST {accessURL}/{organizationName}/pdp_/api/geteffectiveaccess

{accessURL} をクラウド プラットフォームのベース URL に置き換えます。

Cloud Platform	アクセス URL
Test Cloud	https://cloud.uipath.com
Test Cloud (公共部門向け)	https://govcloud.uipath.us
Test Cloud (専有型)	https://{customURL}.dedicated.uipath.com

権限

ユーザー アクセス トークンを使用して実行する要求の場合、呼び出し元は組織管理者である必要があります。テナント管理者には 403 Forbidden 応答が送信されます。

要求ヘッダー

Authorization: Bearer {access_token}
Content-Type: application/json

アクセス トークンの取得の詳細については、「 認証方法」をご覧ください。

クエリ パラメーター

クエリ パラメーター	データ型	説明
top	Integer	返すロール割り当てグループの最大数。既定値は 10で、最大値は 50です。この値を負にすることはできません。
skip	Integer	スキップするロール割り当てグループの数です。既定値は 0で、値を負にすることはできません。

要求本文

次の例は、1 つのセキュリティ プリンシパルに対する組織レベルの有効なアクセス権を取得します。

{
  "securityPrincipalId": "00000000-0000-0000-0000-000000000001",
  "scopeIdentifier": {
    "scopeType": "Organization"
  }
}

プロパティ	データ型	説明
securityPrincipalId	文字列 (GUID)	有効なアクセス権が返されるユーザー、グループ、または外部アプリケーションの識別子。
scopeIdentifier.scopeType	文字列	組織レベルの結果を得るには Organization する必要があります。この値は大文字と小文字を区別しません。
scopeIdentifier.value.id	文字列 (GUID)	任意の組織識別子。含める場合は、呼び出し元の組織と一致する必要があります。
serviceName	文字列	任意のサービス名フィルター。指定したサービスの割り当てのみが返されます。
roleNameStartsWith	文字列	任意のロール名プレフィックス フィルター。ロール名が指定した値で始まる割り当てのみが返されます。

応答

200 OK

要求されたセキュリティ プリンシパルの有効なアクセス情報を返します。

応答プロパティ	説明
roleAssignments	ページ分割された割り当てグループ。テナントとロールでキーを設定しています。tenantIdのないグループには、組織範囲の割り当てが含まれます。組織範囲のグループは、テナント範囲のグループの前に表示されます。
grantedServicesMetadata	プリンシパルにロールが割り当てられている、ページ分割されていない組織全体のサービスのリスト。
grantedRolesMetadata	プリンシパルに付与される、ページ分割されていない組織全体のロールのリスト。

400 Bad Request

ページネーションの値が無効な場合、または scopeIdentifier.value.id 呼び出し元の組織と一致しない場合に返されます。

401 未承認

ベアラー トークンが見つからないか無効な場合に返されます。

403 Forbidden

ユーザー トークンの呼び出し元が組織管理者ではない場合に返されます。

要求の例

curl --location --request POST 'https://cloud.uipath.com/{organizationName}/pdp_/api/geteffectiveaccess?top=10&skip=0' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "securityPrincipalId": "00000000-0000-0000-0000-000000000001",
  "scopeIdentifier": {
    "scopeType": "Organization"
  }
}'