ユーザーの管理 - Drive and Photo Service - Alibaba Cloud ドキュメントセンター

説明

ユーザーはドメイン内で一意の ID を持ちます。アカウントは、ユーザーがログオンするために使用されます。ユーザーは、携帯電話番号やメールアドレスなど、複数のログオンアカウントを持つことができます。

説明

システム定義済みのロールには、user、admin、superadmin が含まれます。

このトピックで言及されている管理者権限は、ロールが admin または superadmin であるユーザーの権限を指します。

説明

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

createUser メソッド

重要

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

ユーザーを作成します。

このメソッドは、ユーザーの作成にのみ使用されます。ドライブおよびフォトサービスによって提供されるログオンメソッドを使用する場合は、LinkAccount オペレーションを呼び出す必要があります。

JSON Web Token（JWT）認証を使用してドライブおよびフォトサービスにアクセスする場合は、LinkAccount オペレーションを呼び出す必要はありません。

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

例

const userInfo = await client.createUser({
  user_id: 'id_123',
  phone: '135****8888',
  email:'username@aliyundoc.com',
  nick_name: 'Nickname',
  user_name: 'Username',
  role: 'user'
})

リクエストパラメーター

パラメーター	タイプ	必須	説明
params	ICreateUserReq	はい	ユーザーの作成に使用されるリクエストパラメーター。
options	IPDSRequestConfig		その他のリクエストパラメーター。

ICreateUserReq パラメーター

パラメーター	タイプ	必須	説明
user_id	string	はい	ユーザーID。
role	string		ユーザーのロール。有効な値：user、admin、superadmin、subdomain、subdomain_super_admin、および subdomain_admin。デフォルト値：user。現在のドメインにユーザーを作成する場合、このパラメーターを subdomain に設定できます。
user_name	string		ユーザー名。
nick_name	string		ユーザーのニックネーム。
description	string		ユーザーの説明。
email	string		ユーザーのメールアドレス。
phone	string		ユーザーの携帯電話番号。
status	string		ユーザーのステータス。有効な値：disabled および enabled。
avatar	string		ユーザーのプロフィール画像。値は http:// で始まる URI であるか、Base64 でエンコードされている必要があります。

レスポンスパラメーター

パラメーター	タイプ	必須	説明
result	IUserItem	はい	返された結果。

IUserItem パラメーター

パラメーター	タイプ	説明
domain_id	string	ドメインID。
user_id	string	ユーザーID。
email	string	ユーザーのメールアドレス。
role	string	ユーザーのロール。
description	string	ユーザーの説明。
phone	string	ユーザーの携帯電話番号。
nick_name	string	ユーザーのニックネーム。
user_name	string	ユーザー名。
status	string	ユーザーのステータス。有効な値：enabled および disabled。
avatar	string	ユーザーのプロフィール画像。
created_at	number	ユーザーが作成された時刻。この値は、1970年1月1日00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。
updated_at	number	ユーザー情報が最後に変更された時刻。この値は、1970年1月1日00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。
default_drive_id	string	デフォルトドライブID。

listUsers メソッド

重要

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

ユーザーをクエリします。

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

例：

const {items=[],next_marker} = await client.listUsers({
  limit: 100,
  marker: ''
})

リクエストパラメーター

パラメーター	タイプ	必須	説明
params	IListReq		ユーザーのクエリに使用されるリクエストパラメーター。このパラメーターを指定しない場合、デフォルト値 {} が使用されます。
options	IPDSRequestConfig		その他のリクエストパラメーター。

IListReq パラメーター

パラメーター	タイプ	必須	説明
marker	string		クエリの開始マーカー。
limit	string		返すエントリの最大数。有効な値：1〜100。デフォルト値：100。

レスポンスパラメーター

パラメーター	タイプ	必須	説明
result	IListRes	はい	返された結果。

IListRes パラメーター

パラメーター	タイプ	必須	説明
items	IUserItem[]	はい	ユーザーのリスト。

getUser メソッド

重要

管理者権限がある場合は、すべてのユーザーに関する情報をクエリできます。そうでない場合は、現在のユーザーに関する情報のみをクエリできます。

ユーザー情報をクエリします。

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

例

const userInfo = await client.getUser({
   user_id: 'id_123'
})

リクエストパラメーター

パラメーター	タイプ	必須	説明
params	Object	はい	ユーザー情報のクエリに使用されるリクエストパラメーター。このパラメーターを指定しない場合、デフォルト値 {} が使用されます。
options	IPDSRequestConfig		その他のリクエストパラメーター。

params パラメーター

パラメーター	タイプ	必須	説明
user_id	string	はい	ユーザーID。

レスポンスパラメーター

パラメーター	タイプ	必須	説明
result	IUserItem	はい	返された結果。

IUserItem パラメーター

パラメーター	タイプ	説明
domain_id	string	ドメインID。
user_id	string	ユーザーID。
email	string	ユーザーのメールアドレス。
role	string	ユーザーのロール。
description	string	ユーザーの説明。
phone	string	ユーザーの携帯電話番号。
nick_name	string	ユーザーのニックネーム。
user_name	string	ユーザー名。
status	string	ユーザーのステータス。有効な値：enabled および disabled。
avatar	string	ユーザーのプロフィール画像。
created_at	number	ユーザーが作成された時刻。この値は、1970年1月1日00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。
updated_at	number	ユーザー情報が最後に変更された時刻。この値は、1970年1月1日00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。
default_drive_id	string	デフォルトドライブID。

generalGetUser メソッド

特定のユーザーをクエリします。

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

例

const userInfo = await client.generalGetUser({
  user_id: 'id_123',
  extra_return_info: ['drive', 'group']
})

リクエストパラメーター

パラメーター	タイプ	必須	説明
params	Object	はい	特定のユーザーのクエリに使用されるリクエストパラメーター。このパラメーターを指定しない場合、デフォルト値 {} が使用されます。
options	IPDSRequestConfig		その他のリクエストパラメーター。

params パラメーター

パラメーター

タイプ

必須

説明

user_id

string

はい

ユーザーID。このパラメーターを指定しない場合、現在のユーザーがクエリされます。

extra_return_info

string[]

クエリするユーザー情報のタイプ。有効な値：drive および group。

このパラメーターは、管理者権限がある場合にのみ有効です。

このパラメーターを group に設定すると、クエリ速度が大幅に低下します。この場合、リクエスト数は30を超えることはできません。

レスポンスパラメーター

パラメーター	タイプ	必須	説明
result	IUserItem	はい	返された結果。

IUserItem パラメーター

パラメーター	タイプ	説明
domain_id	string	ドメインID。
user_id	string	ユーザーID。
email	string	ユーザーのメールアドレス。
role	string	ユーザーのロール。
description	string	ユーザーの説明。
phone	string	ユーザーの携帯電話番号。
nick_name	string	ユーザーのニックネーム。
user_name	string	ユーザー名。
status	string	ユーザーのステータス。有効な値：enabled および disabled。
avatar	string	ユーザーのプロフィール画像。
created_at	number	ユーザーが作成された時刻。この値は、1970年1月1日00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。
updated_at	number	ユーザー情報が最後に変更された時刻。この値は、1970年1月1日00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。
default_drive_id	string	デフォルトドライブID。

updateUser メソッド

重要

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

ユーザーのニックネームやプロフィール画像などの情報を変更します。

await client.updateUser(params, options)

例

// ユーザーを無効にする。
await client.updateUser({  
  user_id: 'id_123',
  status : 'disabled'
})

リクエストパラメーター

パラメーター	タイプ	必須	説明
params	IUpdateUserReq	はい	ユーザー情報の変更に使用されるリクエストパラメーター。このパラメーターを指定しない場合、デフォルト値 {} が使用されます。
options	IPDSRequestConfig		その他のリクエストパラメーター。

IUpdateUserReq パラメーター

パラメーター	タイプ	必須	説明
user_id	string	はい	ユーザーID。
role	string		ユーザーのロール。有効な値：user、admin、および superadmin。デフォルト値：user。
nick_name	string		ユーザーのニックネーム。
description	string		ユーザーの説明。
email	string		ユーザーのメールアドレス。
phone	string		ユーザーの携帯電話番号。
status	string		ユーザーのステータス。有効な値：disabled および enabled。
avatar	string		ユーザーのプロフィール画像。値は http:// で始まる URI であるか、Base64 でエンコードされている必要があります。

レスポンスパラメーター

パラメーター	タイプ	必須	説明
result	IUserItem	はい	返された結果。

deleteUser メソッド

重要

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

ユーザーとユーザーに関連付けられているアカウントを削除します。

await client.deleteUser(params, options)

例

await client.deleteUser({
  user_id: 'id_123'
})

リクエストパラメーター

パラメーター	タイプ	必須	説明
params	Object	はい	ユーザーとユーザーに関連付けられているアカウントの削除に使用されるリクエストパラメーター。このパラメーターを指定しない場合、デフォルト値 {} が使用されます。
options	IPDSRequestConfig		その他のリクエストパラメーター。

params パラメーター

パラメーター	タイプ	必須	説明
user_id	string	はい	ユーザーID。

レスポンスパラメーター

なし。

searchUsers メソッド

重要

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

ユーザーを検索します。

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

例

const {items=[]} = await client.searchUsers({  
  nick_name_for_fuzzy: 'test'
})

リクエストパラメーター

パラメーター	タイプ	必須	説明
params	ISearchUsersReq	はい	ユーザーの検索に使用されるリクエストパラメーター。このパラメーターを指定しない場合、デフォルト値 {} が使用されます。
options	IPDSRequestConfig		その他のリクエストパラメーター。

ISearchUsersReq パラメーター

パラメーター	タイプ	必須	説明
nick_name	string		ユーザーのニックネーム。前方一致がサポートされています。
nick_name_for_fuzzy	string		あいまい検索用のユーザーのニックネーム。
user_name	string		ユーザー名。前方一致がサポートされています。
email	string		ユーザーのメールアドレス。前方一致がサポートされています。
phone	string		ユーザーの携帯電話番号。前方一致がサポートされています。
role	string		ユーザーロール。完全一致が使用されます。
status	string		ユーザーのステータス。完全一致が使用されます。
limit	number		返すエントリの最大数。有効な値：1〜100。デフォルト値：100。
marker	string		クエリの開始マーカー。

レスポンスパラメーター

パラメーター	タイプ	必須	説明
result	IListRes	はい	返された結果。

IListRes パラメーター

パラメーター	タイプ	説明
items	IUserItem[]	返されたユーザー。
next_marker	string	ページネーショントークン。次のリクエストで新しい結果ページを取得するために使用できます。

generalSearchUsers メソッド

グループのユーザーを検索します。

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

例

const {items=[], next_marker} = await client.generalSearchUsers({  
  nick_name_for_fuzzy: 'test',
  direct_parent_group_id: '123456',
  extra_return_info: ['drive', 'group'],
  limit: 30,
  marker: ''
})

リクエストパラメーター

パラメーター	タイプ	必須	説明
params	IUserGeneralSearchReq	はい	グループのユーザーの検索に使用されるリクエストパラメーター。このパラメーターを指定しない場合、デフォルト値 {} が使用されます。
options	IPDSRequestConfig		その他のリクエストパラメーター。

IUserGeneralSearchReq パラメーター

パラメーター	タイプ	必須	説明
nick_name	string		ユーザーのニックネーム。前方一致がサポートされています。
nick_name_for_fuzzy	string		あいまい検索用のユーザーのニックネーム。
parent_group_id_list	string[]		直接ユーザーとサブグループのユーザーをクエリするグループ。
direct_parent_group_id	string		直接ユーザーをクエリするグループ。
extra_return_info	string[]		クエリするユーザー情報のタイプ。有効な値：drive および group。このパラメーターは、管理者権限がある場合にのみ有効です。このパラメーターを group に設定すると、クエリ速度が大幅に低下します。この場合、リクエスト数は30を超えることはできません。
limit	number		返すエントリの最大数。有効な値：1〜100。デフォルト値：100。
marker	string		クエリの開始マーカー。

レスポンスパラメーター

パラメーター	タイプ	必須	説明
result	IListRes	はい	返された結果。

IListRes パラメーター

パラメーター	タイプ	説明
items	IUserItem[]	返されたユーザー。
next_marker	string	ページネーショントークン。次のリクエストで新しい結果ページを取得するために使用できます。

listGroupUsers メソッド

グループの直接メンバーをクエリします。

管理者と一般ユーザーの両方がこのメソッドを使用できます。

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

例

const params = {
  group_id: "abc"
}
const {items=[], next_marker} = await client.listGroupUsers(params)

リクエストパラメーター

パラメーター	タイプ	必須	説明
params	IListGroupUserReq	はい	グループの直接メンバーのクエリに使用されるリクエストパラメーター。このパラメーターを指定しない場合、デフォルト値 {} が使用されます。
options	IPDSRequestConfig		その他のリクエストパラメーター。

IListGroupUserReq パラメーター

パラメーター	タイプ	必須	説明
group_id	string		クエリするグループの ID。
member_type	string		クエリするグループメンバーのタイプ。有効な値：user および group。このパラメーターを指定しない場合、グループの直接ユーザーとサブグループがクエリされます。
extra_return_info	string[]		クエリするユーザー情報のタイプ。有効な値：group および drive。このパラメーターは、管理者権限がある場合にのみ有効です。このパラメーターを group に設定すると、クエリ速度が大幅に低下します。この場合、リクエスト数は 30 を超えることはできません。
limit	number		返すエントリの最大数。有効な値：1〜100。デフォルト値：100。
marker	string		クエリの開始マーカー。

レスポンスパラメーター

パラメーター	タイプ	必須	説明
result	IListRes	はい	返された結果。

IListRes パラメーター

パラメーター

タイプ

説明

items

IGroupItem[] または

IUserItem[]

返されたメンバー。

next_marker

string

ページネーショントークン。次のリクエストで新しい結果ページを取得するために使用できます。

importUser メソッド

重要

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

携帯電話番号またはメールアドレスを使用してログオンするユーザーをインポートします。

この操作を実行する別の方法は、最初に createUser オペレーションを呼び出し、最初の呼び出しが成功した後に createAccountLink オペレーションを呼び出すことです。

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

例

次のサンプルコードは、携帯電話番号を使用してログオンするユーザーをインポートする方法の例を示しています。

await client.importUser({
  authentication_type: 'mobile',
  auto_create_drive: true,
  identity:'135****8888',
  drive_total_size: 1024 * 1024 * 1024,
  nick_name: 'W123'
})

次のサンプルコードは、メールアドレスを使用してログオンするユーザーをインポートする方法の例を示しています。

await client.importUser({
  authentication_type: 'email',
  auto_create_drive: true,
  identity:'username@example.com',
  drive_total_size: 1024 * 1024 * 1024,
  nick_name: 'W123'
})

リクエストパラメーター

パラメーター	タイプ	必須	説明
params	IImportUserReq	はい	ユーザーのインポートに使用されるリクエストパラメーター。このパラメーターを指定しない場合、デフォルト値 {} が使用されます。
options	IPDSRequestConfig		その他のリクエストパラメーター。

IImportUserReq パラメーター

パラメーター	タイプ	必須	説明
auto_create_drive	boolean		ドライブを自動的に作成するかどうかを指定します。
drive_total_size	number		ドライブの合計サイズ。
authentication_type	string		ログオン認証のタイプ。有効な値：mobile、email、ldap、および custom。
identity	string	はい	ユーザーの一意の識別子。 authentication_type パラメーターを mobile に設定する場合は、このパラメーターをユーザーの携帯電話番号に設定する必要があります。 authentication_type パラメーターを email に設定する場合は、このパラメーターをユーザーのメールアドレスに設定する必要があります。 authentication_type パラメーターを ldap に設定する場合は、このパラメーターをユーザーの LDAP アカウントに設定する必要があります。 authentication_type パラメーターを custom に設定する場合は、このパラメーターをカスタム ID に設定する必要があります。
parent_group_id	string
nick_name	string		ユーザーのニックネーム。

レスポンスパラメーター

パラメーター	タイプ	必須	説明
result	IUserItem	はい	返された結果。