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

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

API エンドポイント

GET https://cloud.uipath.com/<yourorgname>/pap_/api/userroleassignments/export

スコープ

次のスコープが必要です。

• PM.User

• PM.User.Read

要求ヘッダー

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

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

クエリ パラメーター

クエリ パラメーター	データ型	説明
exportoutputtype (必須)	string	.json または の 2 つのファイル形式のいずれかを指定します.csv

応答

200 OK

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

要求の例

curl --location -- request GET 'https://cloud.uipath.com/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	割り当てられたロールの一意の識別子です。
OriginalRoleName (元のロール名)	インターフェイスに表示されるロール名。
ロールの説明	インターフェイスに表示されるロールの説明。
ロールの割り当ての種類	作成時のロールの割り当ての種類です。以下の 2 つのオプションのいずれかになります。 - カスタム、ユーザーが行った割り当て。 - 組み込み、システムによって割り当てられます。
ロールの種類	ユーザーまたはシステムによって定義されたロールの種類: - カスタム (ユーザー定義ロール) - 組み込み (システム定義のロール)
スコープ	スコープは、特定のアクション、権限、およびオブジェクトの境界として機能する、組織階層内の特定のレベルです。スコープは、次の階層オプションのいずれかになります。 -組織 -テナント -サービス -フォルダ
SecurityPrincipalId	ユーザー、グループなどの ID の一意の識別子。
SecurityPrincipalType	ユーザー、グループ、またはロボットの ID の種類です。
SecurityPrincipalEmail	ユーザーのメール アドレスです。ID がユーザーでない場合は、このフィールドは空白になります。
SecurityPrincipalDisplayName	ID の名前。ディレクトリ ユーザーの場合は、このフィールドは空白です。
継承元グループ名	ロールの割り当ての継承元のグループ名です。
グループ ID から継承	ロールの割り当ての継承元のグループ識別子です。
テナント名	割り当てを行うテナントの名前です。組織レベルの割り当ての場合は、このフィールドは空白です。
組織名	割り当てが行われる組織の名前。
組織 ID	割り当てが行われる組織の ID。
TenantId	割り当てが行われるテナントの ID です。組織レベルの割り当ての場合は、このフィールドは空白です。
CreatedBy	割り当てを作成したユーザーの一意の識別子です。
作成日	ロールが割り当てられた日時のタイムスタンプ。