すべてのプロダクト
Search
ドキュメントセンター

Drive and Photo Service:ロールの割り当てを管理する

最終更新日:Dec 22, 2025

このトピックでは、ロールの割り当てを管理するために使用されるメソッドについて説明します。

説明

IPDSRequestConfig タイプの options パラメーターは、axios のリクエスト設定オプションに基づいてカプセル化されています。詳細については、AxiosRequestConfig を参照してください。

assignRole メソッド

重要

このメソッドを使用するには、管理者権限が必要です。

ロールを割り当てます。このメソッドを使用して、チーム管理者ロールをユーザーに割り当てることができます。

const result = await client.assignRole(params, options)

const user_id = 'xxx';
const group_id = 'xxxx';

await client.assignRole({
  identity: {
    identity_type: 'IT_User',
    identity_id: user_id,
  },
  role_id: 'SystemGroupAdmin',
  manage_resource_type: 'RT_Group',
  manage_resource_id: group_id,
});

リクエストパラメーター

パラメーター

タイプ

必須

説明

params

IAssignRoleReq

はい

ロールの割り当てに使用するパラメーター。

options

IPDSRequestConfig

その他のリクエストパラメーター。

IAssignRoleReq パラメーター

パラメーター

タイプ

必須

説明

identity

IIDentity

はい

ロールを割り当てるユーザーまたはグループの一意の識別子。

role_id

string

はい

ロール ID。値を SystemGroupAdmin に設定します。

manage_resource_type

string

はい

ロールによって管理できるリソースのタイプ。値を RT_Group に設定します。

manage_resource_id

string

はい

ロールによって管理できるリソースの ID (グループ ID など)。

IIDentity パラメーター

パラメーター

タイプ

必須

説明

identity_type

string

はい

ロールを割り当てるオブジェクトのタイプ。有効な値:IT_User および IT_Group。

identity_id

string

はい

ロールを割り当てるユーザーまたはグループの ID。

レスポンスパラメーター

なし。

cancelAssignRole メソッド

重要

このメソッドを使用するには、管理者権限が必要です。

ロールの割り当てをキャンセルします。このメソッドを使用して、チーム管理者ロールの割り当てをキャンセルできます。

const result = await client.cancelAssignRole(params, options)

const user_id = 'xxx';
const group_id = 'xxxx';

await client.cancelAssignRole({
  identity: {
    identity_type: 'IT_User',
    identity_id: user_id,
  },
  role_id: 'SystemGroupAdmin',
  manage_resource_type: 'RT_Group',
  manage_resource_id: group_id,
});

リクエストパラメーター

パラメーター

タイプ

必須

説明

params

ICancelAssignRoleReq

はい

ロールの割り当てのキャンセルに使用するリクエストパラメーター。

options

IPDSRequestConfig

その他のリクエストパラメーター。

ICancelAssignRoleReq パラメーター

パラメーター

タイプ

必須

説明

identity

IIDentity

はい

ロールの割り当てをキャンセルするユーザーまたはグループの ID。

role_id

string

はい

ロール ID。値を SystemGroupAdmin に設定します。

manage_resource_type

string

はい

ロールによって管理できるリソースのタイプ。値を RT_Group に設定します。

manage_resource_id

string

はい

ロールによって管理できるリソースの ID (グループ ID など)。

レスポンスパラメーター

なし。

listAssignments メソッド

重要

このメソッドを使用するには、管理者権限またはグループ管理者権限が必要です。

割り当てられているロールをクエリします。たとえば、グループの ID を使用して、グループの管理者をクエリできます。

const result = await client.listAssignments(params, options)

const group_id = 'xxxx';

await client.listAssignments({
  manage_resource_type: 'RT_Group',
  manage_resource_id: group_id,
  limit: 100,
});

リクエストパラメーター

パラメーター

タイプ

必須

説明

params

IListAssignmentsReq

はい

割り当てられているロールのクエリに使用するリクエストパラメーター。

options

IPDSRequestConfig

その他のリクエストパラメーター。

IListAssignmentsReq パラメーター

パラメーター

タイプ

必須

説明

limit

long

返すエントリの最大数。有効な値:1~100。

返されるエントリ数は、指定された数以下です。

marker

string

ページネーションの開始マーカー。

manage_resource_type

string

管理対象のリソースのタイプ。値を RT_Group に設定します。この値は、グループの管理者がクエリされることを示します。

manage_resource_id

string

管理対象のリソースの ID (グループ ID など)。

レスポンスパラメーター

パラメーター

タイプ

説明

assignment_list

IAssignment[] | null

割り当てられているロール。

next_marker

string

ページネーション トークン。次のリクエストでこれを使用して、新しいページの結果を取得できます。 next_marker が空の場合、次のページは存在しません。

IAssignment パラメーター

パラメーター

タイプ

説明

domain_id

string

ドメイン ID。

identity

IIDentity

ロールが割り当てられているユーザーまたはグループの ID。

role_id

string

ロール ID。

manage_resource_type

string

ロールによって管理されるリソースのタイプ。RT_Group のみが返される可能性があり、これはグループがロールによって管理されていることを示します。

manage_resource_id

string

ロールによって管理されるリソースの ID (グループ ID など)。

creator

string

ロールを割り当てたユーザーの ID。

created_at

number

ロールが割り当てられた時刻。この値は、1970 年 1 月 1 日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。