ユーザー ロールの割り当てをエクスポートする

Automation Suite の Check Access Export API を使用して、UiPath 製品全体にわたるすべてのロールとロールの割り当てのレポートをエクスポートします。

任意の UiPath® 製品に関連付けられているすべてのロールとロールの割り当てを含むレポートをエクスポートします。

Postman コレクション

Check Access Export API を使用するには、Postman コレクションをダウンロードして Postman アプリにインポートします。

注:

Postman コレクションを使用する場合、応答が 50 MB を超えると、エラーが発生することがあります。Postman のこの設定を変更するには (デスクトップ バージョンおよび Web バージョンに共通)、[ 設定] に移動して [ 一般] を選択し、[ 最大レスポンスサイズ ] を 0 MB に設定します。

API エンドポイント

GET https://{yourDomain}/<yourorgname>/pap_/api/userroleassignments/export

スコープ

プラットフォーム レベルのすべてのスコープが必要です。

要求ヘッダー

--header 'Authorization: Bearer {access_token}'\

注:

{access_token}を取得するには、「認証方法」に記載されているいずれかの方法で認証を行ってください。

クエリ パラメーター

クエリ パラメーター	データ型	説明
exportoutputtype	string	必須。 .json または の 2 つのファイル形式のいずれかを指定します.csv
expandgroupmemberships	string	必須。 true - 応答で AAD グループ メンバーシップを展開できるようにします。 false または未指定 - ローカル グループに属する AAD メンバーはレポートに表示されません。

応答

200 OK

ユーザー ロールとロールの割り当てのレポートが、 .json 形式または .csv 形式でマシンにダウンロードされます。

要求の例

curl --location -- request GET 'https://{yourDomain}/acmeorg/pap_/api/userroleassignments/export?exportoutputtype=json' \
--header 'Authorization: Bearer {your token}

次の応答本文は、ユーザー ロールとロールの割り当てが正常に取得されたことを表します。

[
    {
        "Id": "34ecc3f3-a582-4cad-9889-120d7a3ffd62",
        "RoleUniqueName": "DOCUMENTUNDERSTANDING.DU VIEWER",
        "RoleDescription": "Can view all the entities but has not rights to edit or delete them.",
        "SecurityPrincipalId": "cdc34b5b-77d2-4ae1-9744-209d21ce557d",
        "RoleAssignmentType": "BuiltIn",
        "RoleType": "BUILTIN",
        "Scope": "/",
        "OrganizationId": "feb0dd79-85b6-483b-b297-0e49a1aa5b7d",
        "TenantId": null,
        "CreatedBy": "7f36fcc2-b822-430b-ae30-5ecfbacac186",
        "CreatedOn": "2023-03-30T08:30:04.9346766+00:00"
    },
...
]

次の表では、エクスポートされたファイルのヘッダー フィールドについて説明します。

フィールド	説明
Id	ロールの割り当ての一意の識別子です。
RoleName	インターフェイスに表示されるロール名です。 例: Folder Administrator
RoleId	ロールの一意の識別子です。
RoleDescription	インターフェイスに表示されるロールの説明。たとえば、Folder Administrator です
RoleType	ユーザーまたはシステムによって定義されたロールの種類: - カスタム: ユーザーが定義するロール。 - BuiltIn: デフォルトで管理ポータルに存在するロールです。
RoleAssignmentType	作成時のロールの割り当ての種類です。以下の 2 つのオプションのいずれかになります。 - カスタム:ユーザーが行った割り当て。 - BuiltIn: 管理ポータルでデフォルトで行われる割り当てです。
Scope	範囲は、特定のアクション、権限、オブジェクトの境界として機能する、組織階層内の特定のレベルです。範囲は ID として表される次のいずれかの階層オプションになります。 -組織 -テナント -サービス -フォルダ
ScopeWithDisplayNames	スコープは、特定のアクション、権限、およびオブジェクトの境界として機能する、組織階層内の特定のレベルです。スコープは、次の階層オプションのいずれかになります。 -組織 -テナント -サービス -フォルダ
ServiceName	ロールが属する UiPath サービスの名前です。
SecurityPrincipalId	ユーザー、グループなどの ID の一意の識別子。
SecurityPrincipalType	ユーザー、グループ、またはロボットの ID の種類です。
SecurityPrincipalEmail	ユーザーのメール アドレスです。ID がユーザーでない場合は、このフィールドは空白になります。
SecurityPrincipalDisplayName	ID の名前。ディレクトリ ユーザーの場合は、このフィールドは空白です。
InheritedFromGroupName	ロールの割り当ての継承元のグループ名です。
InheritedFromGroupId	ロールの割り当ての継承元のグループ識別子です。
TenantName	割り当てを行うテナントの名前です。組織レベルの割り当ての場合は、このフィールドは空白です。
OrganizationName	割り当てが行われる組織の名前。
OrganizationId	割り当てが行われる組織の ID。
TenantId	割り当てが行われるテナントの ID です。組織レベルの割り当ての場合は、このフィールドは空白です。
CreatedBy	割り当てを作成したユーザーの一意の識別子です。
CreatedByDisplayName	割り当てを作成するユーザーの名前です。
CreatedOn	ロールが割り当てられた日時のタイムスタンプ。
FolderName	割り当てに関連付けられているフォルダーの名前です。
FolderKey	割り当てに関連付けられたフォルダーの一意の識別子です。
ProjectId	割り当てに関連付けられているプロジェクト (Document Understanding や IXP など) の ID です。